Skip to content

by Startups.Studio

Core grammar Interface

Interface.create

POST /{namespace}/interfaces

Creates an Interface.

Noun: Interface
Mode: do
Event: Interface.created

You, to your agent

Add an interface to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/interfaces \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"api"}'

import { $ } from 'startup-builder'

const result = await $.Interface.create({ kind: 'api' })

npx startup-builder do Interface.create --json '{"kind":"api"}'

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

Create makes a new Interface 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 `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.
`product`	Product		Each Interface exposes one Product; a Product is reached through many Interfaces.

Outputs

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

Effects

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

Interface

Previous Page

Interface.delete

Next Page