Get credit balance
Source-generated GET /credits/balance reference: authentication, fields, responses, errors, and operational safeguards.
On this page
Operation
GET /credits/balance
operationId: credits_balance_v1_credits_balance_get
Read currently available credits shared by web and API use. Verified accounts may access the API, while cost-bearing generation still requires enough credits. Quote the intended operation before spending.
Authentication and side effects
Use a server-side Bearer API key. Required scope: animations:read
This operation does not start paid generation. Other state changes are described above.
Parameters
No path, query, or operation-specific header parameters.
Responses
| HTTP | Body | Meaning |
|---|---|---|
200 |
CreditsBalanceResponse | Successful public response. Example values are illustrative. |
400 |
APIErrorEnvelope | Invalid input; correct the request before retrying. |
401 |
APIErrorEnvelope | Missing, expired, or revoked API key. |
403 |
APIErrorEnvelope | Account eligibility, account status, or key scope does not allow this operation. |
404 |
APIErrorEnvelope | Resource is unavailable, not owned, or its signature is invalid/expired. |
429 |
APIErrorEnvelope | Account-wide rate or queue limit; wait for Retry-After. |
500 |
APIErrorEnvelope | Internal failure; preserve the task/key and retry only when marked retryable. |
503 |
APIErrorEnvelope | Service/provider unavailable; retry only when error.retryable is true. |
Response headers
| HTTP | Header | Type | Meaning |
|---|---|---|---|
429 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
503 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
Response example
{
"available": 1,
"object": "credit_balance"
}
Related guides
Was this page helpful?
No search queries, code, or free text are collected. This switch controls documentation interactions only; general site analytics follow the privacy policy. Privacy policy