批量查询视频生成任务
本接口用于按条件批量查询视频生成任务列表,支持按状态、任务 ID、模型和服务等级等条件筛选,并支持分页返回。
提示
仅支持查询最近 7 天内创建的历史任务。时间范围以发起查询请求的时刻为基准,向前推算 7 天(精确到秒)。
请求方法
GET:<ai-api-base-url>/llm/v1/contents/generations/tasks
其中,<ai-api-base-url> 为您的 API Key 所属数据中心的域名:
- 北京数据中心:
https://ai.rong-api.com - 北美数据中心:
https://ai.us-light-api.com
请求头参数
| 参数名 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
Authorization | string | 是 | - | 身份认证令牌,格式为 Bearer <your API key>,需替换为实际 API Key,用于验证用户权限。 |
Query 参数
以下参数通过 URL Query String 传入。
| 参数名 | 类型 | 是否必填 | 默认值 | 说明 |
|---|---|---|---|---|
page_num | integer | 否 | 1 | 返回结果的页码。取值范围:[1, 500]。 |
page_size | integer | 否 | - | 每页返回的结果数量。取值范围:[1, 500]。 |
filter.status | string | 否 | - | 按任务状态筛选。可选值:queued(排队中)、running(运行中)、cancelled(已取消)、succeeded(已完成)、failed(已失败)。 |
filter.task_ids | string[] | 否 | - | 按任务 ID 精确查询,支持同时查询多个。多个 ID 通过 & 连接,例如:filter.task_ids=id1&filter.task_ids=id2。 |
filter.model | string | 否 | - | 按任务使用的模型接入标识精确筛选。该字段对应任务实际使用的模型或接入点标识,而不一定等同于展示名称。 |
filter.service_tier | string | 否 | default | 按服务等级筛选。可选值:default、flex。 |
请求示例
- cURL
- Python
- JavaScript
bash
curl --request GET \
--url '<ai-api-base-url>/llm/v1/contents/generations/tasks?page_num=1&page_size=10&filter.status=succeeded&filter.service_tier=default' \
--header 'Authorization: Bearer <token>'
python
import requests
url = "<ai-api-base-url>/llm/v1/contents/generations/tasks"
params = {
"page_num": 1,
"page_size": 10,
"filter.status": "succeeded",
"filter.service_tier": "default"
}
headers = {
"Authorization": "Bearer <token>"
}
response = requests.get(url, params=params, headers=headers)
print(response.text)
JavaScript
const params = new URLSearchParams({
page_num: 1,
page_size: 10,
'filter.status': 'succeeded',
'filter.service_tier': 'default'
});
const options = {
method: 'GET',
headers: {
'Authorization': 'Bearer <token>'
}
};
fetch(`<ai-api-base-url>/llm/v1/contents/generations/tasks?${params}`, options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
返回结果
| 参数名 | 类型 | 是否必返 | 说明 |
|---|---|---|---|
items | object[] | 是 | 查询到的视频生成任务列表。每个元素的字段结构与查询视频生成任务接口的返回体一致。 |
| items[].id | string | 是 | 任务 ID。 |
| items[].model | string | 是 | 执行任务所使用的模型名称。 |
| items[].status | enum<string> | 是 | 任务状态:queued、running、succeeded、failed、cancelled、expired。其中 cancelled 仅表示排队中任务被取消,expired 表示任务在排队或执行期间超过 execution_expires_after 阈值。 |
| items[].error | object | 否 | 任务失败时返回,包含错误详情。 |
| items[].error.code | string | 否 | 错误码。 |
| items[].error.message | string | 否 | 错误描述信息。 |
| items[].created_at | integer | 是 | 任务创建时间(Unix 时间戳,单位:秒)。 |
| items[].updated_at | integer | 是 | 任务最后更新时间(Unix 时间戳,单位:秒)。 |
| items[].content | object | 否 | 任务成功后返回,包含生成视频和尾帧等结果信息。 |
| items[].content.video_url | string | 否 | 视频下载地址(24 小时有效)。 |
| items[].content.last_frame_url | string | 否 | 尾帧图像地址(24 小时有效,仅 return_last_frame: true 时返回)。 |
| items[].seed | integer | 否 | 随机种子。 |
| items[].resolution | string | 否 | 视频分辨率,如 "720p"。 |
| items[].ratio | string | 否 | 视频宽高比,如 "16:9"。 |
| items[].duration | integer | 否 |