API 规范
查询余额
查询当前鉴权账户剩余的 API credits。
GET
bearerheader
AuthorizationBearer <token>usage_page?numberOne-based usage history page. When provided, the response includes up to 20 usage records.
Range
1 <= valueapplication/json- response
error?string错误码，当请求无法提交时返回。该字段会随 HTTP 201 一起在响应体中返回，因此客户端必须检查此字段，而不能仅依赖 HTTP 状态码。成功时省略此字段。错误码详细请参考 [errors](/zh/api-specification/errors)。
Value in
"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*number剩余账户余额（以信用额度计）。此值为瞬时值，因为并发任务可能会消耗信用额度。
usage?array<>所请求页面的使用记录，按最新到最旧排序。仅在提供了 usage_page 时返回。
Example Request
curl -X GET 'https://api.hyper3d.com/api/v2/check_balance'Example Response
{ "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_page 时，响应中不包含 usage。
示例
curl --fail-with-body 'https://api.hyper3d.com/api/v2/check_balance?usage_page=1' \
--header "Authorization: Bearer ${RODIN_API_KEY}"
响应
{
"balance": 10,
"usage": [
{
"time": "2026-08-05T08:30:00.000Z",
"item": "api_generation_rodin",
"amount": 5,
"task_uuid": "123e4567-e89b-12d3-a456-426614174000"
}
]
}