Balance
Query the current API account balance or available credit state.
This endpoint returns the balance or credit state of the API key's team workspace.
GET /v1/user/balanceOverview
| Item | Description |
|---|---|
| Route | GET /v1/user/balance |
| Auth | Authorization: Bearer sk_yeehoo_xxx |
| Request body | None |
| Response | 200 OK + balance object |
Typical use cases
- Console balance page
- Preflight quota checks
- Monitoring and alerts
Authorizations
Authorization: Bearer sk_yeehoo_your_api_keyResponse
{
"quota_amount": 1000,
"authorized_amount": 120,
"currency": "credits",
"wallet_account_id": "wallet_01jxyz..."
}Response fields
| Field | Type | Description |
|---|---|---|
quota_amount | number | Credits currently available for new task authorization |
authorized_amount | number | Credits authorized or reserved by running work; not lifetime purchased credits |
currency | string | Balance unit, normally credits |
wallet_account_id | string | Wallet account ID for reconciliation and support |
Integration notes
- If your business is sensitive to quota, check this endpoint before calling generation APIs
- If you submit many async tasks concurrently, also estimate quota usage on your side
- This is a good support endpoint for dashboards, alerts, and automation