认证
authorization string 必需
所有 API 都需要通过 Bearer Token 进行身份验证
获取 API Key:
访问 API Key 管理页面 获取您的 API Key
使用方式:
添加到请求头:
Authorization: Bearer YOUR_API_KEY参数
model string 必需
请求使用的模型 ID
值: viduq2_turbo_start_end2video
images array 必需
首尾帧图像，支持输入两张图，上传的第一张图片视作首帧图，第二张图片视作尾帧图，模型将以此参数中传入的图片来生成视频
格式要求：
首尾帧两张输入图的分辨率需相近，首帧图的分辨率/尾帧图的分辨率要在 0.8 ~ 1.25 之间，且图片比例需要小于 1:4 或者 4:1
支持传入图片 Base64 编码或图片 URL（确保可访问）
支持格式：png, jpeg, jpg, webp
图片大小不超过 50MB
请注意, http 请求的 post body 不超过 20MB, 且编码必须包含适当的内容类型字符串. 例如：data:image/png;base64,{base64_encode}
prompt string
生成视频的文本描述，字符长度不能超过 2000 个字符
若使用 is_rec 推荐提示词参数，模型将不考虑此参数所输入的提示词
is_rec boolean
是否使用推荐提示词
当为 true 时，由系统自动推荐提示词，并使用提示词内容生成视频，推荐提示词数量 = 1；当为 false 时，根据输入的 prompt 生成视频
注意: 启用推荐提示词后，每个任务多消耗积分
可选值: true, false
默认值: false
duration integer
视频时长, 单位为秒
可选值: 1, 2, 3, 4, 5, 6, 7, 8
默认值: 5
seed integer
随机种子，当默认不传或者传 0 时, 使用随机数替代，手动设置则使用设置的种子
resolution string
分辨率参数
可选值: 540p, 720p, 1080p
默认值: 720p
movement_amplitude string
运动幅度
可选值: auto, small, medium, large
默认值: auto
bgm boolean
是否为生成的视频添加背景音乐
当为 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加；当为 false 时不添加 BGM
BGM 不限制时长，系统根据视频时长自动适配
可选值: true, false
默认值: false
payload string
透传参数，不做任何处理, 仅数据传输，最多 1048576 个字符
off_peak boolean
注意: 暂不可用
错峰模式，错峰模式消耗的积分更低. 错峰模式下提交的任务会在 48 小时内生成. 未能完成的任务会被自动取消, 并返还该任务的积分
当为 true 时错峰生成视频；当为 false 时即时生成视频
可选值: true, false
默认值: false
watermark boolean
是否添加水印. 当为 true 时添加水印；当为 false 时不添加水印
目前水印内容为固定, 内容由 AI 生成, 默认不加
可选值: 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
回调 URL
轮询
由于视频生成需要时间, 您需要在创建后轮询任务状态
初始响应返回任务 ID 和初始状态. 必须通过轮询任务状态端点获取实际生成结果
响应格式
可选值: true, false
默认值: false
is_rec boolean
是否使用推荐提示词
true: 系统将自动生成并应用推荐提示词来创建视频. 推荐提示词数量为 1
false: 视频将根据用户提供的提示词生成
启用推荐提示词功能将额外消耗每个任务 10 积分
可选值: true, false
默认值: false
响应格式
error object
错误信息. 仅在 status 为 failed 时出现
code
string错误码
message
string详细错误消息
output array
生成结果. 仅在 status 为 completed 时出现
content
array生成的内容列表
type
string资源类型
值:
videourl
string生成内容的 URL
usage object
使用统计信息. 仅在 status 为 completed 时出现
cost
string总费用（美元）
discount
number折扣金额
metadata object
元数据信息
错误代码
| 错误代码 | 描述 |
|---|---|
| 002014001 | 图像缺失 |