Account

Get the caller's credit balance

Returns the authenticated caller's spendable credit balance - the same number as credits.balance on GET /api/v1/me, without the identity and plan fields. Use it to check a key can afford a batch before starting one. The subject is always the credential holder; this endpoint accepts no user or owner id. balance is the caller's personal ledger; a call billed to an organization draws on a pool this number does not describe. Responses are never cacheable. Authenticate with an API key (b4m_live_) carrying any one of me:read, ai:chat, ai:generate or ai:decide, or a JWT.

get/api/v1/credits

Request

  • Base URL: https://your-deployment.example.com
  • URL: https://your-deployment.example.com/api/v1/credits
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Response

The caller's personal credit balance.

balancenumber required

Example response

{
  "balance": 31667
}

Changes

No recorded changes to this operation across all 1 revision of this API.