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.

Path Parameters

deviceId
string
required

Owned device identifier.

Response

Authoritative durable projection.

id
string
required
deviceId
string
required
status
enum<string>
required
Available options:
active,
interrupted,
ended
billing
enum<string>
required
Available options:
minute
currency
string
required
rateMicrosPerMinute
string
required

Integer micros. One settlement-currency unit equals 1,000,000 micros.

Pattern: ^(0|[1-9][0-9]{0,17})$
contractVersion
string
required
activation
string<date-time>
required
authorizedUntil
string<date-time>
required

Current short control authorization boundary, not total funded duration or contract end.

settledThrough
string<date-time>
required

The persisted rental fee settlement cursor; consumedMicros is settled through this instant.

authorizationVersion
integer
required

Version of supported-deadline extensions only; not a general rental projection revision.

Required range: x >= 1
serviceEpoch
integer
required
Required range: x >= 0
incarnation
string
required
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})$
cleanup
enum<string>
required
Available options:
pending,
complete
canReturn
boolean
required
canResume
boolean
required
modelSources
enum<string>[]
required
Available options:
byok,
external,
managed
currentContract
enum<string>
Available options:
minute,
legacy
managedModelTerms
object
modelAccess
object
interruption
object
chargeEnd
string<date-time>
endReason
enum<string>
Available options:
returned,
funds_exhausted
returnImpact
object
resumeQuote
object