Skip to main content
GET
Get credit balances and current usage

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST endpoints the Workspace write API scope.

Response

Success. Empty result sets are also 200.

Live snapshot — today per agent, current month per team.

totalBalance
number
required
totalBalanceNoNegative
number
required

totalBalance floored at zero.

topupBalance
number
required
subscriptionBalance
number
required
isSandboxBlockedByProductionReserve
boolean
required

True while the balance has fallen to the reserve, which stops every sandbox agent regardless of its own limit.

agentUsage
object
required

Keyed by agent id. Covers every agent, including disabled and private ones.

groupUsage
object
required

Keyed by team id.

lastUpdated
string

ISO 8601 timestamp.

defaultDailyCreditLimitPerAgent
number
productionCreditReserve
number

Credits held back for production agents. Absent when lifecycle phases are off or no reserve is set.

{key}
any