API 规范
查询状态
查询已提交任务关联的全部 job。
POST
bearerheader
AuthorizationBearer <token>application/json- body
subscription_key*string生成响应中 jobs.subscription_key 返回的任务订阅键。
application/json- response
error?"NO_SUCH_TASK"错误码，当请求无法提交时返回。该字段会随 HTTP 201 一起在响应体中返回，因此客户端必须检查此字段，而不能仅依赖 HTTP 状态码。成功时省略此字段。错误码详细请参考 [errors](/zh/api-specification/errors)。
Value in
"NO_SUCH_TASK"jobs?array<>一个包含生成过程中执行的各个任务详细信息的工作对象。
message?string成功消息或详细错误信息。
Example Request
curl -X POST 'https://api.hyper3d.com/api/v2/status' \ -H 'Content-Type: application/json' \ -d '{ "subscription_key": "your-subscription-key"}'Example Response
{ "error": "NO_SUCH_TASK", "jobs": [ { "uuid": "123e4567-e89b-12d3-a456-426614174000", "status": "Waiting", "queue_length": 0 } ], "message": "string"}标识选择
此接口需要生成响应中的 jobs.subscription_key。不要传入顶层 uuid，也不要传入 jobs.uuids 中的值。
Job 状态
jobs 中的每个条目都会返回以下四种状态之一：
| 状态 | 含义 |
|---|---|
Waiting | 排队中，或正在等待依赖的 job。 |
Generating | 有 worker 正在执行该 job。 |
Done | 该 job 的结果已可下载。 |
Failed | 该 job 已停止，不会产出结果。 |
当 job 处于 Waiting 时，响应中还可能包含 queue_length，表示排在它前面的 job 的大致数量。job 离开队列后该字段会被省略。
示例
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"}'
响应
{
"jobs": [
{
"uuid": "223e4567-e89b-12d3-a456-426614174000",
"status": "Done"
}
]
}
轮询与错误
查询成功返回 HTTP 201。HTTP 400 表示请求体无效，401 表示鉴权缺失或无效，429 表示触发限流。首次查询前等待 5 秒，逐步退避到最长 30 秒，遵循 Retry-After；任一 job 为 Failed 时立即停止，并设置客户端总期限。