批量查询视频生成任务
本接口用于按条件批量查询视频生成任务列表,支持按状态、任务 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(运行中)、succeeded(已完成)、failed(已失败)、cancelled(已取消)。 |
| filter.task_ids | string[] | 否 | - | 按任务 ID 精确查询,支持同时查询多个。多个 ID 通过 & 连接,例如:filter.task_ids=id1&filter.task_ids=id2。 |
| filter.model | string | 否 | - | 按模型名称精确筛选。 |
请求示例
- 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' \
--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"
}
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'
});
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。 |
| items[].content | object | 否 | 任务完成后返回,包含 video_url(视频下载地址,24 小时有效)和 last_frame_url(尾帧图像地址,24 小时有效,仅 return_last_frame: true 时 返回)。 |
| items[].usage | object | 否 | Token 用量:completion_tokens(输出 token)、total_tokens(总 token)。 |
| items[].error | object | 否 | 任务失败时返回,包含 code(错误码)和 message(错误描述)。 |
| items[].created_at | integer | 是 | 任务创建时间(Unix 时间戳,单位:秒)。 |
| items[].updated_at | integer | 是 | 任务最后更新时间(Unix 时间戳,单位:秒)。 |
| items[].seed | integer | 否 | 随机种子。 |
| items[].resolution | string | 否 | 视频分辨率,如 "720p"。 |
| items[].ratio | string | 否 | 视频宽高比,如 "16:9"。 |
| items[].duration | integer | 否 | 视频时长(单位:秒)。 |
| items[].framespersecond | integer | 否 | 视频帧率(FPS)。 |
| items[].generate_audio | boolean | 否 | 是否包含同步音频。 |
| total | integer | 是 | 符合筛选条件的任务总数量。 |
返回结果示例
JSON
{
"items": [
{
"id": "cgt-2025xxxxxx-xxxx",
"model": "Doubao/Doubao-seedance-1.5-pro",
"status": "succeeded",
"content": {
"video_url": "https://example.com/generated-video.mp4"
},
"usage": {
"completion_tokens": 246840,
"total_tokens": 246840
},
"created_at": 1765510475,
"updated_at": 1765510559,
"seed": 58944,
"resolution": "1080p",
"ratio": "16:9",
"duration": 5,
"framespersecond": 24,
"generate_audio": false
}
],
"total": 1
}