Balance
GET /api/v1/balance reference — the current credit balance for the authenticated key.
GET /api/v1/balance returns the current credit balance for the credentials
making the request. Use it to show remaining credits in your own dashboard, or
to check a key has funds before submitting work.
Reading this endpoint does not consume credits.
GET /api/v1/balance
Request
GET /api/v1/balance
Authorization: Bearer rk_live_xxxNo body and no query parameters.
Response
200 OK:
{
"balance": 12500
}Response fields
| Field | Type | Description |
|---|---|---|
balance | integer | Current credit balance. Integer credits, 1 credit = $0.001. |
Errors
| HTTP | code | When |
|---|---|---|
| 401 | 10001 – 10005 | Auth missing / malformed / invalid / revoked |
| 429 | 50001 | Per-user rate limit exceeded — retry after Retry-After seconds |
| 500 | 60099 | Unexpected server error |
Full list: Errors.