Skip to content

by Startups.Studio

Goal.create

POST /{namespace}/goals

Creates a Goal.

Noun: Goal
Mode: do
Event: Goal.created

You, to your agent

Add a goal to RouteWise.

curl -X POST https://api.sb/routewise.dev/goals \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"objective":"Example objective"}'

import { $ } from 'startup-builder'

const goal = await $.Goal.create({ objective: 'Example objective' })

npx startup-builder do Goal.create --json '{"objective":"Example objective"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Goal.create({ objective: 'Example objective' })"
  }
}

Create makes a new Goal from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`objective`	`text`	required	The qualitative outcome.
`horizon`	`string`		One of `day`, `week`, `quarter`, `year`, or `three-years`.
`thing`	Thing		Every Thing pursues Goals, such as a Startup’s quarterly objective or a Team’s weekly target.

Outputs

Output	Type	Required	Description
`goal`	Goal	required	The Goal.

Effects

Emits Goal.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Goal.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Goal

Previous Page

Goal.delete

Next Page