Get Credits
Platform API
Get Credits
Check remaining credits for your API key
GET
Get Credits
Check the remaining credit balance for your API key. This endpoint returns your current credit count and last top-up timestamp without consuming any credits.
Example Response:
Get Credits
Response
The endpoint returns a JSON object with your credit information:Response Fields
| Field | Type | Description |
|---|---|---|
| credits | integer | Number of credits remaining in your account |
| last_topup_at | string or null | ISO 8601 timestamp of your last credit purchase/top-up |
Examples
Check Credits:Error Responses
| Status Code | Description |
|---|---|
| 401 | Unauthorized - API key missing or invalid |
| 404 | Not Found - Unable to retrieve credit information |
| 500 | Internal Server Error - Credit service error |
Notes
- This endpoint is free - no credits are consumed
last_topup_atwill benullif no credits have been purchased- Use this endpoint to check balance before making credit-consuming API calls