GET https://ark.cn-beijing.volces.com/api/v3/contents/generations/tasks
当您要查询符合条件的任务,您可以传入条件筛选参数,返回符合要求的任务。
鉴权#
本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。
- API Key 鉴权,请在 API Key 管理 页面,获取长效 API Key。
请求参数#
Query 参数#
在 URL Query String 中传入。
filter object | 筛选条件
用于筛选任务的参数。
model string | 推理接入点 ID 筛选
filter.model
任务使用的推理接入点(Endpoint)ID,精确搜索。可在控制台 [在线推理] → [自定义推理接入点] 页面复制推理接入点 ID (格式为 ep- 开头的字符串), 或通过创建推理接入点接口获取。
status string | 任务状态筛选
filter.status
过滤参数,查询某个任务状态。任务状态,以及相关的信息:
queued:排队中。running:任务运行中。cancelled:取消任务,取消状态 24h 自动删除(只支持queued状态的任务被取消)。succeeded:任务成功。failed:任务失败。
task_ids string[] | 任务 ID 筛选
filter.task_ids
3D 生成任务 ID,精确搜索,支持同时搜索多个任务 ID。需通过重复参数名的方式传递,示例:filter.task_ids=id1&filter.task_ids=id2
page_num integer 默认值 1 | 页码
返回结果的页码。
取值范围:[1, 500]
page_size integer 默认值 20 | 每页数量
每页显示的结果数量。
取值范围:[1, 500]
响应参数#
items object[] | 任务列表
查询到的 3D 生成任务列表
id string | 任务 ID
items.id
3D 生成任务 ID
model string | 模型名称与版本
items.model
任务使用的模型名称和版本,格式为 模型名称-版本
status string | 任务状态
items.status
任务状态,以及相关的信息:
queued:排队中。running:任务运行中。cancelled:取消任务,取消状态 24h 自动删除(只支持queued状态的任务被取消)。succeeded:任务成功。failed:任务失败。
content object | 输出内容
items.content
3D 生成任务完成时返回的输出内容,包含生成 3D 文件下载的 URL
file_url string | 文件 URL
items.content.file_url
生成的 3D 文件的 URL。为保障信息安全,生成的 3D 文件会在 24 小时后被清理,请及时转存。
created_at integer | 创建时间
items.created_at
任务创建时间的 Unix 时间戳(秒)
error object | 错误信息
items.error
错误提示信息。任务成功时返回 null,任务失败时返回错误数据,错误信息具体参见 错误处理
code string | 错误码
items.error.code
message string | 错误提示信息
items.error.message
fileformat string | 文件格式
items.fileformat
生成的 3D 文件格式。
subdivisionlevel string | 多边形面数
items.subdivisionlevel
3D 文件中多边形面的数量。
updated_at integer | 更新时间
items.updated_at
任务当前状态更新时间的 Unix 时间戳(秒)
usage object | token 用量
items.usage
本次请求的 token 用量
completion_tokens integer | 生成 3D 内容消耗的 token 数
items.usage.completion_tokens
模型生成 3D 内容消耗的 token 数量,可作为计费对账依据。
total_tokens integer | 总 token 数
items.usage.total_tokens
本次请求消耗的总 token 数量。3D 生成模型不统计输入 token,输入 token 为 0,故 total_tokens = completion_tokens
total integer | 任务总数
符合筛选条件的任务数量