Skip to content

by startups.studio

by Startups.Studio

MCP ProductDomains and accessAPI Key

API Key programs: get, list

The API Key Verbs get, list as MCP do programs, with inputs, result, refusals and an example.

Reference for API Key, one group of API Key programs.

APIKey.get

Returns one API Key by id. Verb page.

Text

do: return await $.APIKey.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the API Key.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`apiKey`	API Key	required	The API Key.

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

JSON

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

APIKey.list

Returns API Keys, newest first, one page at a time. Verb page.

Text

do: return await $.APIKey.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	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
`apiKeys`	list of API Key	required	One page of API Keys.

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

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.APIKey.list({ limit: 20 })"
  }
}

API Key

Previous

issue, revoke, roll

Next