Skip to content

by Startups.Studio

Core grammar Interface

Interface.get

GET /{namespace}/interfaces/{id}

Returns one Interface by id.

Noun: Interface
Mode: read

You, to your agent

Show me the latest interface.

curl https://api.sb/shiftnote.app/interfaces/interface_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const result = await $.Interface.get({ id: 'interface_1' })

npx startup-builder do Interface.get --json '{"id":"interface_1"}'

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

Get returns one Interface by id. 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.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

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

Effects

Reads only: it emits no Event and changes nothing.
Read: try, 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.get

When it waits

Never: a read runs at once.

Interface.delete

Previous Page

Interface.list

Next Page