Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarFunction

Function routes: create, get, list

The Function Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Function, one group of Function routes.

Function.create

Creates a Function. Verb page.

Text
POST /{namespace}/functions

Body, as JSON: the inputs. Emits Function.created.

Inputs

InputTypeRequiredDescription
kindstringrequiredOne of code, generative, agentic, or human.
cascadestring[]Kinds tried in order when one declines, such as code, then a Human.
instructionstextFor a generative or agentic Function, what it does and how.
modelstringFor a generative or agentic Function, the model it runs on.
toolslist of VerbFor an agentic Function, the Verbs it may call; Permissions and Limits apply to each.
maxStepsintegerFor an agentic Function, the most steps one Action may take.
budgetmoneyThe most one Action may spend; the Mandate’s Limits apply as well.
roleRoleFor a human Function, the Role its Tasks go to.
formjsonFor a human Function, the form; generated from the Verb’s inputs and outputs when absent.
slastringFor a human Function, how long a Task may wait, as an ISO 8601 duration.
escalateToRoleFor a human Function, the Role a Task moves to when the service level passes.

Returns

OutputTypeRequiredDescription
functionFunctionrequiredThe Function.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/functions \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"code"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "function": {
    "$id": "https://api.sb/leaseline.app/functions/function_6nvaxFYImd",
    "$type": "Function",
    "kind": "code"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Function.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Function.get

Returns one Function by id. Verb page.

Text
GET /{namespace}/functions/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Function.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
functionFunctionrequiredThe Function.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/functions/function_6nvaxFYImd \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Function",
  "$id": "https://api.sb/leaseline.app/functions/function_6nvaxFYImd",
  "function": {
    "$id": "https://api.sb/leaseline.app/functions/function_6nvaxFYImd",
    "$type": "Function",
    "kind": "code"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/functions/function_6nvaxFYImd",
    "up": "https://api.sb/leaseline.app/functions"
  }
}

Function.list

Returns Functions, newest first, one page at a time. Verb page.

Text
GET /{namespace}/functions

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
functionslist of FunctionrequiredOne page of Functions.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/functions?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Function",
  "functions": [
    {
      "$id": "https://api.sb/leaseline.app/functions/function_6nvaxFYImd",
      "$type": "Function",
      "kind": "code"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "function_6nvaxFYImd"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/functions?limit=20",
    "next": "https://api.sb/leaseline.app/functions?after=function_6nvaxFYImd"
  }
}

Function

Previous

update, delete

Next