Retrieve the current balance of credits available in your account.
Usage Guide
- Use this endpoint to check your current credit balance
- Monitor usage to ensure sufficient credits for continued service
- Plan credit replenishment based on your usage patterns
Developer Notes
- Credit balance is required for all generation services
- Service access will be restricted when credits are depleted
- Credits are consumed based on the specific service and usage volume
Authorizations
All APIs require authentication via Bearer Token.
Get API Key:
- Visit API Key Management Page to get your API Key
Usage: Add to request header: Authorization: Bearer YOUR_API_KEY
Response
Request successful
Response Status Code
| Code | Description |
|---|---|
| 200 | Success - Request has been processed successfully |
| 401 | Unauthorized - Authentication credentials are missing or invalid |
| 402 | Insufficient Credits - Account does not have enough credits to perform the operation |
| 404 | Not Found - The requested resource or endpoint does not exist |
| 422 | Validation Error - The request parameters failed validation checks |
| 429 | Rate Limited - Request limit has been exceeded for this resource |
| 455 | Service Unavailable - System is currently undergoing maintenance |
| 500 | Server Error - An unexpected error occurred while processing the request |
| 505 | Feature Disabled - The requested feature is currently disabled |
Available options:
200, 401, 402, 404, 422, 429, 455, 500, 505 Error message when code != 200
Example:
"success"
Remaining credit quantity
Example:
100
