Skip to main content
GET
Get credit balances and current usage

Authorizations

Authorization
string
header
required

Workspace API key (wk_) with the Workspace read API scope enabled.

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
agentUsage
object
required

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

groupUsage
object
required

Keyed by team id.

lastUpdated
string
defaultDailyCreditLimitPerAgent
number
{key}
any