Check Balance
Read the remaining API credits for the authenticated account.
bearerAuthorizationBearer <token>usage_page?numberOne-based usage history page. When provided, the response includes up to 20 usage records.
1 <= valueapplication/json- response
error?stringError code, if the request could not be submitted. This is returned in the response body alongside HTTP 201, so clients must check this field rather than relying on the HTTP status alone. This field is omitted on success. For detailed error code information, please refer to: [errors](/en/api-specification/errors)
"NO_SUCH_TASK""ASSET_NOT_AVAILABLE""IMAGE_LABEL_LENGTH_TOO_LONG""INVALID_REQUEST""API_NO_ACTIVE_SUBSCRIPTION""API_SUBSCRIPTION_PLAN_TOO_LOW""API_PARALLELISM_LIMIT_REACHED""API_INSUFFICIENT_FUNDS""API_OBJECT_NOT_FOUND_ON_IMAGE""IMAGE_CONTENT_VIOLATION""PERMISSION_DENIED""API_UNKNOWN"balance*numberRemaining account balance in credits. Treat this as a point-in-time value because concurrent tasks can consume credits.
usage?array<>Usage records for the requested page, ordered from newest to oldest. Returned only when usage_page is provided.
curl -X GET 'https://api.hyper3d.com/api/v2/check_balance'{ "error": "NO_SUCH_TASK", "balance": 10, "usage": [ { "time": "2026-08-05T08:30:00.000Z", "item": "api_generation_rodin", "amount": 5, "task_uuid": "123e4567-e89b-12d3-a456-426614174000", "api_key_id": 123, "api_key_description": "Production" } ]}Usage history
When usage_page is omitted, the response does not include usage.
Examples Input
curl --fail-with-body 'https://api.hyper3d.com/api/v2/check_balance?usage_page=1' \
--header "Authorization: Bearer ${RODIN_API_KEY}"
Response
{
"balance": 10,
"usage": [
{
"time": "2026-08-05T08:30:00.000Z",
"item": "api_generation_rodin",
"amount": 5,
"task_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
]
}