Skip to content

by Startups.Studio

Core grammar Function

Function.create

POST /{namespace}/functions

Creates a Function.

Noun: Function
Mode: do
Event: Function.created

You, to your agent

Add a function to PetPantry.

curl -X POST https://api.sb/petpantry.shop/functions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"code"}'

import { $ } from 'startup-builder'

const result = await $.Function.create({ kind: 'code' })

npx startup-builder do Function.create --json '{"kind":"code"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Function.create({ kind: 'code' })"
  }
}

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

Inputs

Input	Type	Required	Description
`kind`	`string`	required	One of `code`, `generative`, `agentic`, or `human`.
`cascade`	`string[]`		Kinds tried in order when one declines, such as code, then a Human.
`instructions`	`text`		For a generative or agentic Function, what it does and how.
`model`	`string`		For a generative or agentic Function, the model it runs on.
`tools`	list of Verb		For an agentic Function, the Verbs it may call; Permissions and Limits apply to each.
`maxSteps`	`integer`		For an agentic Function, the most steps one Action may take.
`budget`	`money`		The most one Action may spend; the Mandate’s Limits apply as well.
`role`	Role		For a human Function, the Role its Tasks go to.
`form`	`json`		For a human Function, the form; generated from the Verb’s inputs and outputs when absent.
`sla`	`string`		For a human Function, how long a Task may wait, as an ISO 8601 duration.
`escalateTo`	Role		For a human Function, the Role a Task moves to when the service level passes.

Outputs

Output	Type	Required	Description
`function`	Function	required	The Function.

Effects

Emits Function.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.	Function.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`.

Function

Previous Page

Function.delete

Next Page