Check Status
Check all jobs associated with a submitted task.
bearerAuthorizationBearer <token>application/json- body
subscription_key*stringRequired. The subscription key of the task whose status you want to query. This is returned as `jobs.subscription_key` in the response from a generation API call.
application/json- response
error?"NO_SUCH_TASK"Error 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"jobs?array<>The jobs of the task, containing details of individual jobs executed as part of the generation process.
message?stringAdditional status or error details.
curl -X POST 'https://api.hyper3d.com/api/v2/status' \ -H 'Content-Type: application/json' \ -d '{ "subscription_key": "your-subscription-key"}'{ "error": "NO_SUCH_TASK", "jobs": [ { "uuid": "123e4567-e89b-12d3-a456-426614174000", "status": "Waiting", "queue_length": 0 } ], "message": "string"}Identifier
Send jobs.subscription_key from the generation response. Do not send the top-level uuid or an entry from jobs.uuids to this endpoint.
Job states
Each entry in jobs reports one of four states:
| State | Meaning |
|---|---|
Waiting | Queued, or waiting for a job it depends on. |
Generating | A worker is running the job. |
Done | Results for this job can be downloaded. |
Failed | The job stopped and will not produce results. |
While a job is Waiting, the response may also carry queue_length, an approximate count of jobs ahead of it. The field is omitted once the job leaves the queue.
Examples Input
curl --fail-with-body --request POST 'https://api.hyper3d.com/api/v2/status' \
--header "Authorization: Bearer ${RODIN_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"subscription_key":"subscription-key-from-generation-response"}'
Response
{
"jobs": [
{
"uuid": "223e4567-e89b-12d3-a456-426614174000",
"status": "Done"
}
]
}
Polling and errors
The endpoint returns HTTP 201 on a successful query. HTTP 400 indicates an invalid body, 401 indicates missing or invalid authentication, and 429 indicates throttling. Start after 5 seconds, back off to at most 30 seconds, honor Retry-After, stop on any Failed job, and impose a client-side deadline.