提交文生视频任务
1. 接口地址
https://www.hidreamai.com/api-pub/gw/v2/video/txt2video/async
2. 请求方式
POST
3. 请求参数
Header
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| Authorization | string | 是 | 客户授权Token |
| Content-Type | string | 是 | 使用json传参 |
| API-User-ID | string | 否 | 用户唯一标识 |
Body
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| prompt | string | 是 | 生成视频的提示词 |
| aspect_ratio | string | 否 | 视频长宽比例，当前支持值: (16:9, 1:1，9:16)，默认为16:9 |
| request_id | string | 否 | 请求的ID，默认为"" |
| camera_move_horizontal | int | 否 | 水平运镜参数，参数范围（-5, 5），默认为0 |
| camera_move_vertical | int | 否 | 垂直运镜参数，参数范围（-5, 5），默认为0 |
| camera_move_depth | int | 否 | 纵深运镜参数，参数范围（-5, 5），默认为0 |
| motion_strength | float | 否 | 运动强度，参数范围（0，30），默认为9.0 |
| resolution_ratio | int | 否 | 视频分辨率，支持（1024，2048，4096）三个选项，默认1024 |
| notify_url | string | 否 | 任务完成回调通知接口(需公网能访问)，请求体包含main_task_id(任务的task_id）、sub_task_results |
curl示例
curl -H 'Authorization: Bearer {USER_Authorization}' -H 'Content-Type: application/json' -X POST -d '{
"prompt": "小丑鱼在海葵丛中游来游去",
"aspect_ratio": "16:9",
"camera_move_depth": -5,
"camera_move_vertical": 0,
"camera_move_horizontal": 5,
"motion_strength": 10.0,
"resolution_ratio": 1024,
"request_id": "96cf0c6a-5d2b-11ee-abe3-3a8d18c35977"
}' -v 'https://www.hidreamai.com/api-pub/gw/v2/video/txt2video/async'
Python示例
import requests
import json
import uuid
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 = {
"prompt": "小丑鱼在海葵丛中游来游去", # 必要参数
"aspect_ratio": "1:1",
"camera_move_horizontal": 0,
"camera_move_vertical": 0,
"camera_move_depth": 0,
"motion_strength": 9.0,
"resolution_ratio": 1024,
"request_id": str(uuid.uuid4())
}
# 发送POST请求
url = 'https://www.hidreamai.com/api-pub/gw/v2/video/txt2video/async'
response = requests.post(url, headers=headers, data=json.dumps(data))
# 处理响应
if response.status_code == 200:
if response.json()['code'] == 0:
task_id = response.json()['result']['task_id']
print(task_id)
else:
print(response.json()['message'])
else:
print(response.status_code)
4. 返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 返回状态码 |
| message | string | 返回状态信息 |
| request_id | string | 本次请求的ID |
| result | dict | 返回结果 |
其中返回结果 result字段具体为：
| 参数 | 类型 | 说明 |
|---|---|---|
| task_id | string | 返回任务ID |
| sub_task_ids | list | 返回子任务ID的列表，子任务定义为生成单张图片的任务 |
示例：
{
"code": 0,
"message": "请求成功",
"request_id": "96cf0c6a-5d2b-11ee-abe3-3a8d18c35977",
"result": {
"sub_task_ids": [
"94ecd4e4-7d90-4daa-8edb-f3ee02fafa19"
],
"task_id": "97004e6a-5d2b-11ee-abe3-3a8d18c35977"
}
}