Agent credit balance

GET/v1/balance

Authorization

AuthorizationBearer token (JWT) · headerrequired

Verified AgentID agent JWT (iss https://auth.agentid.com) or an AgentSub OAuth access token (typ at+jwt, iss https://api.agentsub.dev, scope agentsub:agent). The agent's human owner must exist in Clerk with the same verified email.

Responses

200

Balance in microcredits (integer decimal string)

availableUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$

heldUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$

spentUcMicrocreditsrequired

Integer microcredits as a decimal string. 1 credit = 1,000,000 microcredits = $0.01 USD.

matches ^[0-9]+$

lotsobject[]

401

unauthorized problem; live 401s advertise WWW-Authenticate: Bearer resource_metadata=...

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

503

Runtime or provider configuration unavailable (runtime_configuration_required, signing_configuration_required, runtime_unavailable, workspace_unavailable, provider_configuration_required)

typestringrequired

titlestringrequired

statusintegerrequired

codestringrequired

Request

curl -X GET 'https://api.agentsub.dev/v1/balance' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.agentsub.dev/v1/balance", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.agentsub.dev/v1/balance",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "availableUc": "string",
  "heldUc": "string",
  "spentUc": "string",
  "lots": [
    {}
  ]
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}

{
  "type": "https://agentsub.dev/problems/not_found",
  "title": "string",
  "status": 0,
  "code": "string"
}