Interface methods: create, get, list

Reference for Interface, one group of Interface methods.

Interface.create

Creates an Interface. Verb page.

TypeScript

interface InterfaceVerbs {
  create(input: InterfaceCreateInput, options?: SB.CallOptions): SB.Call<Interface>
}

Emits Interface.created.

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.

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

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

Returns one Interface by id. Verb page.

TypeScript

interface InterfaceVerbs {
  get(input: InterfaceGetInput, options?: SB.CallOptions): SB.Call<Interface>
}

Reads only: it emits no Event.

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.

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

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

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

TypeScript

interface InterfaceVerbs {
  list(input?: InterfaceListInput, options?: SB.CallOptions): SB.ListCall<Interface>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`interfaces`	list of Interface	required	One page of Interfaces.

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

Example

TypeScript

import { $ } from 'startup-builder'

const interfaces = await $.Interface.list({ limit: 20 })