查询所有模型生成任务的状态与结果。
任务
获取任务信息
查询所有模型生成任务的状态与结果。
GET
查询所有模型生成任务的状态与结果。
API 端点
该端点用于查询通过
/api/v1/client/job/CreateTask 接口创建的任务执行状态,并获取任务结果。
它提供统一的查询接口,兼容 模型 分类下的所有模型,无论底层模型如何,均可一致地进行任务追踪与结果获取。查询参数
创建任务时返回的唯一任务标识符。示例:
task_12345678请求示例
响应格式
响应状态码。200 表示请求已成功处理(任务已找到并返回,与执行结果无关)。
响应消息,通常为
"success"。包含所有任务信息的任务数据对象。
任务状态枚举
| 状态 | 描述 | 操作建议 |
|---|---|---|
pending | 任务已入队,等待处理 | 继续轮询 |
running | 任务正在处理中 | 继续轮询 |
success | 任务成功完成 | 访问 result.media_url 获取结果 |
failed | 任务失败 | 访问 result 对象查看错误码和错误信息 |
获取任务结果的最佳实践
推荐轮询间隔
推荐轮询间隔
- 轮询间隔:建议轮询间隔设置为 15 至 30 秒
- 动态调整间隔:对于长时间运行的视频生成任务,建议动态增加轮询间隔
- 延迟首次轮询:首次状态检查前至少等待一个轮询间隔,以减少不必要的请求
- 最大轮询时长:超过 15-20 分钟后应停止并进行排查
使用回调代替轮询
使用回调代替轮询
对于生产环境应用,我们强烈建议在创建任务时使用
callback_url 参数:- 无需轮询:服务器自动接收通知
- 降低 API 成本:避免持续的轮询请求
- 性能更优:任务完成后立即收到通知
- 减少延迟:完成与通知之间无延迟
处理已完成的任务
处理已完成的任务
当
status 为 success 时:- 从响应的
result字段获取任务结果 - 从
result.media_urls中提取生成的媒体 URL - 将媒体文件下载至您自己的存储空间
- 将结果元数据持久化至您的存储或数据库
常见错误码
| 错误码 | 描述 | 解决方案 |
|---|---|---|
401 | 未授权 - API 密钥无效或缺失 | 检查您的 API 密钥 |
404 | 任务未找到 | 验证 task_id 是否正确 |
429 | 超出请求频率限制 | 降低请求频率 |
500 | 服务器内部错误 | 几分钟后重试 |
501 | 生成失败 | 查看 result 对象获取错误码和错误信息 |
频率限制
- 最大查询速率:每账号每秒最多 15 次请求
- 推荐间隔:每次轮询间隔 15-30 秒
相关资源
模型概览
探索所有可用模型
获取账户额度
查看您的剩余积分
授权
所有 API 均需通过 API Key 进行身份验证。
获取 API Key:
- 访问 API Key 管理页面 获取您的 API Key
使用方式: 将以下内容添加至请求头:
x-api-key: YOUR_API_KEY
注意事项:
- 请妥善保管您的 API Key,切勿与他人共享
- 若怀疑 API Key 已泄露,请立即在管理页面进行重置
查询参数
用于获取任务结果的任务 ID。
Required string length:
36示例:
"task_1234567"
响应
任务信息获取成功或任务未找到。
