批量查询视频结果
1. 接口地址
https://www.hidreamai.com/api-pub/gw/v2/video/<MODULE>/async
其中MODULE为生视频模型，目前支持以下几种：
| 类型 | 说明 |
|---|---|
| txt2video | 文生视频 |
| img2video | 图生视频 |
| video_edit | 视频风格化 |
2. 请求方式
POST
3. 请求参数
Header
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| Authorization | string | 是 | 客户授权Token |
| Content-Type | string | 是 | 使用json传参 |
| API-User-ID | string | 否 | 用户唯一标识 |
Body
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| task_id_list | list | 是 | 需要查询的任务的id列表 |
| notify_url | string | 否 | 任务完成回调通知接口(需公网能访问)，请求体包含main_task_id(任务的task_id）、result |
curl示例
curl -H 'Authorization: Bearer {USER_Authorization}' -H 'Content-Type: application/json' -X POST -d '{
"task_id_list": ["f48051cc-e109-11ee-b588-be4091741d67", "c29574f4-e117-11ee-aee0-8ab6933153da"],
}' -v 'https://www.hidreamai.com/api-pub/gw/v2/video/txt2video/async/results/batch'
Python示例
import requests
import json
USER_Authorization = <token> # 获取方式详见接口文档https://www.hidreamai.com/docs/pixeling/user/token.html
# 请求头
headers = {
'Authorization': f'Bearer {USER_Authorization}',
'Content-Type': 'application/json',
'API-User-ID': '' # 可选的用户唯一标识
}
# 请求体参数
data = {
"task_id_list": ["f48051cc-e109-11ee-b588-be4091741d67", "c29574f4-e117-11ee-aee0-8ab6933153da"]
}
# 发送POST请求
url = 'https://www.hidreamai.com/api-pub/gw/v2/video/txt2video/async/results/batch'
response = requests.post(url, headers=headers, data=json.dumps(data))
# 处理响应
if response.status_code == 200:
if response.json()['code'] == 0:
results = response.json()['result']
for result in results:
sub_task_results = result['sub_task_results']
for sub_task_result in sub_task_results:
print(f"task_status: {sub_task_result['task_status']}, task_completion: {sub_task_result['task_completion']}, video_url: {sub_task_result['video']}")
else:
print(response.json()['message'])
else:
print(response.status_code)
4. 返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 返回状态码 |
| message | string | 返回状态信息 |
| request_id | string | 本次请求的ID |
| result | list | 返回结果 |
| 参数 | 类型 | 说明 |
|---|---|---|
| task_id | string | 任务的task_id |
| sub_task_results | list | 各个子任务的生成结果(若传入的task_id_list参数中存在不存在任务，则对应的sub_task_results字段为空列表。) |
其中sub_task_result字段具体为
| 参数 | 类型 | 说明 |
|---|---|---|
| sub_task_id | string | 子任务的task_id |
| task_status | int | 子任务的状态，0: 等待中，1: 完成，2: 处理中，3: 失败，4：未通过审核 |
| task_completion | float | 子任务的进度，取值范围为0-1的小数点后保留2位的小数 |
| video | string | 生成的视频的url, eg.'https://media.hidreamai.com/63c3bc8f-4990-41eb-8c3d-46247735e9b6.mp4' |
示例：
{
"code": 0,
"message": "请求成功",
"request_id": "cdb5f35a-e11b-11ee-b3bd-6aea5a175df8",
"result": [
{
"sub_task_results": [
{
"sub_task_id": "67375f2a-bd41-4905-b422-61e957e1be89",
"task_completion": 1,
"task_status": 1,
"video": "https://media.hidreamai.com/99090e36-9ac1-439f-91c7-5f62293e8904.mp4",
"video_wm": "https://media.hidreamai.com/99090e36-9ac1-439f-91c7-5f62293e8904_wm.mp4"
}
],
"task_id": "f48051cc-e109-11ee-b588-be4091741d67"
},
{
"sub_task_results": [
{
"sub_task_id": "49df0d8c-6c71-4a41-8032-cf427c9bc726",
"task_completion": 1,
"task_status": 1,
"video": "https://media.hidreamai.com/74109859-4ac6-48c5-ba5b-aa5a027b8461.mp4",
"video_wm": "https://media.hidreamai.com/74109859-4ac6-48c5-ba5b-aa5a027b8461_wm.mp4"
}
],
"task_id": "c29574f4-e117-11ee-aee0-8ab6933153da"
}
]
}