API v1

列出团队任务

GET/v1/video/tasks

列出当前团队的全部任务,不限于创建任务的那一把 API Key,按创建时间从新到旧排序,同一时刻用任务标识排序。

查看 Markdown
  • 在请求头 Authorization: Bearer 后面放 API 密钥。
  • 列出团队的全部任务,不限于创建任务的那一把 API 密钥,从新到旧排列。
  • 用 next_cursor 翻页;最后一页为空。
  • 用量、费用、结果和错误请按任务 ID 查询任务详情。

请求头

#Authorizationstring必填

Bearer 加一个空格和 API 密钥。缺失或无效时返回 401 authentication_failed。

#X-Request-IDstring

你自己的请求标识。无效或重复的值会被替换,最终值在响应头 X-Request-ID 返回。

查询参数

#cursorstring

上一页 next_cursor 返回的不透明游标。不是服务为本团队此列表签发的游标返回 invalid_request。

长度1–256
#page_sizeinteger

此页最多返回的任务数。

默认50范围1–100

返回HTTP 200

本团队的一页任务。

#objectstring必填

对象类型标识。

固定为list
#dataarray必填

本页的任务列表项。

数量≤ 100
12 个子字段
#idstring必填

平台任务标识。

长度4–128字符A–Z a–z 0–9 _ -
#request_idstring必填

请求关联标识。

长度4–128字符A–Z a–z 0–9 _ -
#billing_correlation_idstring必填

费用关联标识。

长度4–128字符A–Z a–z 0–9 _ -
#modelstring必填

本次使用的模型标识。

dreamina-seedance-2-0-260128Seedance 2.0
dreamina-seedance-2-0-fast-260128Seedance 2.0 Fast
dreamina-seedance-2-0-mini-260615Seedance 2.0 Mini
#statusstring必填

当前状态,具体含义见对应取值。

queued排队中
processing处理中
succeeded已成功
failed已失败
cancelled已取消
#phasestring必填可能为空

任务执行阶段;没有当前阶段时为空。

preparing_assets准备素材
waiting_route等待处理
submitting准备生成
provider_processing生成中
reconciling确认结果中
finalizing整理结果
settlement_pending等待结算
null空值
#delivery_statusstring必填

结果交付状态。

pending待交付
materializing准备下载
available可下载
output_unavailable结果不可用
#settlement_statusstring必填

当前费用结算状态。

reserved已预留费用
pending待处理
reconciliation_required需要核对
settled已结算
settled_with_receivable已结算,仍有应收金额
#created_atinteger必填

创建时间,Unix 整数秒。

范围≥ 0
#started_atinteger必填可能为空

任务开始时间,未开始时为空。

范围≥ 0
#completed_atinteger必填可能为空

任务完成时间,未完成时为空。

范围≥ 0
#cancellationobject可能为空

存在取消操作时附带其稳定标识、状态及原因码;没有操作时省略。

3 个子字段
#cancel_operation_idstring必填

取消操作的稳定标识。

长度4–128字符A–Z a–z 0–9 _ -
#statusstring必填

当前状态,具体含义见对应取值。

requested已请求取消
effective取消已生效
not_effective取消未生效
failed失败
#reason_codestring必填可能为空

取消未生效或失败时的原因码;已请求或已生效时为空。

长度1–96字符a–z 0–9 _
#next_cursorstring必填可能为空

下一页游标;最后一页为空。

长度1–256

响应头

#X-Request-IDstring必填

本次请求的标识:你提供的有效值,或替换后的值。

状态码

每个 error.code 的处理办法见「错误码」。

状态码说明与 error.code
200本团队的一页任务。
400请求无效。
401API 密钥缺失或无效。
响应头WWW-Authenticate
429请求频率限制拒绝此非创建操作。
响应头Retry-After
500服务内部错误。
503服务暂时不可用。