Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

The control surface credential. Send Authorization: Bearer <token>.

Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.

Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.

Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.

Body

application/json

Validated operation fields; monetary amounts are server-quoted.

requestId
string
required
Pattern: ^[a-zA-Z0-9_.:-]{1,120}$
model
string
required
Pattern: ^[a-z0-9][a-z0-9-]{0,63}$
region
string
required
Pattern: ^[A-Z]{2}$
quantity
integer
required
Required range: 1 <= x <= 1000
identityId
string

An identity id from the catalog, or any (or omitted) for automatic.

Response

Authoritative durable projection.

kind
enum<string>
required
Available options:
started
start
object
required
order
object
required