认证
authorization string 必填
所有 API 都需要通过 Bearer Token 进行身份验证.
获取 API Key:
访问 API Key 管理页面 获取您的 API Key
使用方式:
添加到请求头:
Authorization: Bearer YOUR_API_KEY
参数
model string 必填
请求使用的模型 ID
值: vidu20_img2video
images array 必填
将用作生成视频起始帧的图像.
格式要求:
仅接受 1 张图像
支持公开 URL 或 Base64 格式
支持格式:png, jpeg, jpg, webp
图像的宽高比必须小于 1:4 或 4:1
所有图像大小限制为 50MB
HTTP 请求 POST 正文不得超过 20MB, 且必须包含适当的内容类型字符串. 示例:data:image/png;base64,{base64_encode}
prompt string
视频生成的文本描述, 最大 2000 个字符
注意: 如果在推荐提示词中使用了 is_rec 参数, 模型将忽略此参数手动输入的提示词内容
duration integer
视频时长, 单位为秒
可选值: 4, 8
默认值: 4
resolution string
分辨率, 基于模型和时长.
vidu2.0(4 秒):可选设置 360p, 720p, 1080p
vidu2.0(8 秒):固定为 720p
默认值: 360p(4 秒时), 720p(8 秒时)
seed integer
随机种子. 默认值为随机种子数. 手动设置的值将覆盖默认随机种子
默认值: 0
movement_amplitude string
场景中物体的运动幅度
可选值: auto, small, medium, large
默认值: auto
payload string
透传参数. 无需处理, 仅数据传输, 最大传输长度为 1048576 个字符
audio boolean
是否使用音视频直出能力。当为 true 时, 输出带台词以及背景音的视频;当为 false 时, 输出静音视频
该参数为 true 时, voice_id 参数才生效, 且不支持错峰
可选值: true, false
默认值: false
voice_id string
音色 ID,用来决定视频中的声音音色
为空时系统会自动推荐,可选枚举值参考列表
is_rec boolean
是否使用推荐提示词。当为 true 时, 由系统自动推荐提示词并使用提示词内容生成视频, 推荐提示词数量为 1;当为 false 时, 根据输入的 prompt 生成视频
启用推荐提示词后, 每个任务会多消耗积分
可选值: true, false
bgm boolean
是否为生成的视频添加背景音乐。传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加;不传或为 false 则不添加 BGM
BGM 不限制时长, 系统根据视频时长自动适配
可选值: true, false
默认值: false
watermark boolean
是否添加水印。当为 true 时添加水印;当为 false 时不添加水印
目前水印内容为固定, 内容由 AI 生成, 默认不加
可选值: true, false
wm_position integer
水印位置, 表示水印出现在图片的位置。1 为左上角, 2 为右上角, 3 为右下角, 4 为左下角
可选值: 1, 2, 3, 4
默认值: 3
wm_url string
水印内容,此处为图片 URL
不传时,使用默认水印:内容由 AI 生成
callback_url string
回调 URL
off_peak boolean
注意: 暂不可用
非高峰模式. 非高峰模式消耗更少的积分, 请参阅详细定价信息. 在非高峰时段提交的任务将在 48 小时内生成. 未完成的任务将自动取消并退还积分. 我们也支持取消非高峰任务. 除 q3 外, 其他直接音视频生成功能不支持非高峰模式.
可选值: true, false
默认值: false
轮询
由于视频生成需要时间, 您需要在创建任务后轮询任务状态
初始响应返回任务 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
元数据信息.
错误码
| 错误码 | 描述 |
|---|---|
| 008005001 | 图像缺失 |
| 008005002 | 参数无效 |
| 008005003 | 风格无效 |
| 008005004 | 图像无效 |
| 008005005 | 时长无效 |
| 008005006 | 分辨率无效 |
| 008005098 | 生成失败 |
| 008005099 | 服务不可用 |