Skip to content

by Startups.Studio

Core grammar Interface

Interface.update

PATCH /{namespace}/interfaces/{id}

Changes the given properties of an Interface.

Noun: Interface
Mode: do
Event: Interface.updated

You, to your agent

Change the latest interface.

curl -X PATCH https://api.sb/tutorloop.com/interfaces/interface_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"api"}'

import { $ } from 'startup-builder'

const result = await $.Interface.update({ id: 'interface_1', kind: 'api' })

npx startup-builder do Interface.update --json '{"id":"interface_1","kind":"api"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Interface.update({ id: 'interface_1', kind: 'api' })"
  }
}

Update changes the given properties of an Interface. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Interface.
`kind`	`string`		One of `api`, `mcp`, `cli`, `sdk`, `site`, `app`, `docs`, or `webhooks`.
`path`	`string`		Where it is mounted on its Domain, such as `/api`.
`conformsTo`	`json`		The Standards it also speaks, each mapping the Standard’s operations onto the Product’s Verbs.

Outputs

Output	Type	Required	Description
`interface`	Interface	required	The Interface.

Effects

Emits Interface.updated.
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.	Interface.update

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

Interface.list

Previous Page

Lifecycle

Next Page