Skip to main content
GET
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.

Response

Authoritative durable projection.

currency
string
required
version
integer
required
Required range: x >= 0
availableMicros
string
required

Canonical integer micros for aggregate balances and lifetime consumption; individual approved amounts retain their separate limits.

Pattern: ^(0|[1-9][0-9]{0,39})$
reservedMicros
string
required

Canonical integer micros for aggregate balances and lifetime consumption; individual approved amounts retain their separate limits.

Pattern: ^(0|[1-9][0-9]{0,39})$
consumedMicros
string
required

Canonical integer micros for aggregate balances and lifetime consumption; individual approved amounts retain their separate limits.

Pattern: ^(0|[1-9][0-9]{0,39})$
updatedAt
string<date-time>
required
funding
object[]
required
transactions
object[]
required
permissions
object
required
fundingPolicy
object