Skip to main content
GET
Get sandbox AI usage

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Path Parameters

sandboxId
string
required

Public Sandbox id returned by create/list/get sandbox calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Query Parameters

days
integer
default:30

Days of history, today included.

Required range: 1 <= x <= 365

Response

The usage.

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

sandboxId
string
required
blocked
boolean
required

True when the proxy refuses this sandbox's placeholders.

proxied
boolean
required

True when the sandbox holds placeholders, not real keys.

credentialProfileId
string | null
required

The profile the sandbox uses. Null means its owner's default.

since
string<date>
required
usage
object[]
required
totals
object
required

Token counts are the numbers the provider reports in its replies.

dollars
number
required