认证
authorization string 必需
所有 API 均使用 Bearer Token 鉴权
获取 API Key：
访问 API Key 管理页面 获取 API Key
用法：
将以下 Header 添加到请求中：
Authorization: Bearer YOUR_API_KEY参数
model string 必需
请求使用的模型 ID
值: viduq3_pro_text2video
prompt string 必需
文本提示词, 用于描述要生成的视频内容
限制: 字符长度不能超过 5000 个字符
duration integer
视频时长参数
可选值: 1 - 16
默认值: 5
seed integer
随机种子, 默认不传或传 0 时会使用随机数, 手动设置时使用设置的种子
aspect_ratio string
比例参数
可选值: 16:9, 9:16, 3:4, 4:3, 1:1
默认值: 16:9
resolution string
分辨率参数
可选值: 540p, 720p, 1080p
默认值: 720p
audio boolean
是否使用音视频直出能力
false: 不需要音视频直出, 输出静音视频
true: 需要音画同步, 输出声音的视频（包括台词和音效）
可选值: true, false
默认值: true
payload string
透传参数, 不做任何处理, 仅数据传输
限制: 最多 1048576 个字符
off_peak boolean
注意: 暂不可用
错峰模式
true: 错峰生成视频
false: 即时生成视频
注 1: 错峰模式消耗的积分更低
注 2: 错峰模式下提交的任务会在 48 小时内生成, 未能完成的任务会被自动取消并返还该任务积分
注 3: 您也可以手动取消错峰任务
可选值: true, false
默认值: false
watermark boolean
是否添加水印
true: 添加水印
false: 不添加水印
注 1: 目前水印内容固定, 内容为 AI 生成, 默认不添加
注 2: 可通过 watermarked_url 字段获取带水印视频内容
可选值: true, false
默认值: false
wm_position integer
水印位置, 表示水印在画面中的位置
1: 左上角
2: 右上角
3: 右下角
4: 左下角
默认值: 3
wm_url string
水印内容图片 URL, 不传时使用默认水印（内容由 AI 生成）
meta_data string
元数据标识, JSON 格式字符串, 透传字段
您可以自定义格式或使用示例格式. 示例如下：
{
"Label": "your_label",
"ContentProducer": "yourcontentproducer",
"ContentPropagator": "your_content_propagator",
"ProduceID": "yourproductid",
"PropagateID": "your_propagate_id",
"ReservedCode1": "yourreservedcode1",
"ReservedCode2": "your_reserved_code2"
}该参数为空时, 默认使用 vidu 生成的元数据标识
callback_url string
Callback 协议地址, 需要在创建任务时主动设置 callback_url, 请求方法为 POST
轮询
由于结果生成需要时间，您需要在创建任务后轮询任务状态
初始响应只返回任务 ID 和初始状态等信息，最终生成结果需通过使用该任务 ID 轮询任务状态接口获取
轮询请求与响应示例见右侧
响应格式
error object
错误信息. 仅在 status 为 failed 时出现
code
integer错误码
error_message
string详细错误消息
output array
生成结果. 仅在 status 为 completed 时出现
content
array生成的内容列表
type
string资源类型
值:
videourl
string生成内容的 URL
usage object
使用统计信息. 仅在 status 为 completed 时出现
cost
string总费用（美元）
discount
number折扣金额
metadata object
元数据信息