创建任务
POST
/ent/v2/reference2video查询生成物
GET
/ent/v2/tasks/{id}/creationsVidu Q-视频模型
注：viduq3-mix 暂不支持主体调用方法
创建主体方法：https://platform.vidu.cn/docs/subjects
modelString*模型名称可选值：viduq1``viduq1：画面清晰，平滑转场，运镜稳定
auto_subjectsbool是否使用智能主体库能力，默认false，可选值 true、false- true：使用智能主体库能力。- false：不使用智能主体库能力。
subjectsList[Array]*Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}idstring*任务id，由创建任务接口创建成功返回
使用q3、q2、q1、2.0模型时，只能使用图片主体和文字主体图片或文字主体最多不超过7个
nameString*用户指定的主体名称（name），生成时可以通过[@name]的方式使用，例如：[@图1]
imagesArray{String}临时主体图片，最多3张图片注1：支持传入图片 Base64 编码或图片URL（确保可访问）注2：图片支持 png、jpeg、jpg、webp格式注3：图片像素不能小于 128*128，且比例需要小于1:4或者4:1注4：请注意，http请求的post body不超过20MB，且编码必须包含适当的内容类型字符串，例如：data:image/png;base64,{base64_encode}
videosArray[String]临时主体视频，最多1个5秒视频注1：仅参考生viduq2-pro模型支持使用视频主体注2：最多支持上传 1个5秒 的视频注3：视频支持 mp4、avi、mov格式注4：视频像素不能小于 128*128，且比例需要小于1:4或者4:1注5：请注意，base64 decode之后的字节长度需要小于20M，且编码必须包含适当的内容类型字符串，例如：data:video/mp4;base64,{base64_encode}
voice_idpromptString*文本提示词生成视频的文本描述。注1：字符长度不能超过 5000 个字符注2：通过[@subjects_name] 来表示主体内容，例如："@1 和 @2 在一起吃火锅，并且旁白音说火锅大家都爱吃。"
audioBool是否使用音视频直出能力，默认false，可选值 true、false- true：使用音视频直出能力。- false：不使用音视频直出能力。
durationInt视频时长参数，默认值依据模型而定viduq1：默认5秒，可选：5
seedInt随机种子当默认不传或者传0时，会使用随机数替代手动设置则使用设置的种子
aspect_ratioString默认 16:9，可选值如下：1:1、9:16、16:9、3:4、4:3auto：根据输入图或视频自动推荐
resolutionString分辨率参数，默认值依据模型和视频时长而定：viduq1 （5秒）：默认 1080p, 可选：1080p
movement_amplitudeString运动幅度默认 auto，可选值：auto、small、medium、large
payloadString透传参数不做任何处理，仅数据传输注：最多 1048576个字符
off_peakBool错峰模式，默认为：false，可选值：- true：错峰生成视频；- false：即时生成视频；注1：错峰模式消耗的积分更低，具体请查看产品定价注2：错峰模式下提交的任务，会在48小时内生成，未能完成的任务会被自动取消，并返还该任务的积分；注3：您也可以手动取消错峰任务注4：q2、q1、2.0系列模型在audio为false时支持错峰任务
watermarkBool是否添加水印- true：添加水印；- false：不添加水印；注1：目前水印内容为固定，内容由AI生成，默认不加注2：您可以通过watermarked_url参数查询获取带水印的视频内容，详情见查询任务接口
wm_positionInt水印位置，表示水印出现在图片的位置，默认为：3，可选项为：1：左上角2：右上角3：右下角4：左下角
wm_urlString水印内容，此处为图片URL不传时，使用默认水印：内容由AI生成
meta_dataString元数据标识，json格式字符串，透传字段，您可以 自定义格式 或使用 示例格式 ，示例如下：{"Label": "your_label","ContentProducer": "yourcontentproducer","ContentPropagator": "your_content_propagator","ProduceID": "yourproductid", "PropagateID": "your_propagate_id","ReservedCode1": "yourreservedcode1", "ReservedCode2": "your_reserved_code2"}该参数为空时，默认使用vidu生成的元数据标识
callback_urlStringCallback 协议需要您在创建任务时主动设置 callback_url，请求方法为 POST，当视频生成任务有状态变化时，Vidu 将向此地址发送包含任务最新状态的回调请求。回调请求内容结构与查询任务API的返回体一致回调返回的"status"包括以下状态：- processing 任务处理中- success 任务完成（如发送失败，回调三次）- failed 任务失败（如发送失败，回调三次）Vidu采用回调签名算法进行认证，详情见：回调签名算法
task_idStringVidu 生成的任务ID
stateString处理状态
可选值：
created 创建成功
queueing 任务排队中
processing 任务处理中
success 任务成功
failed 任务失败
modelString本次调用的模型名称
promptString本次调用的提示词参数
imagesArray[String]本次调用的图像参数
durationIntAuthorizationstring*将 {your api key} 替换为您的 token
Token {your api key}Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}modelstring*模型名称可选值：viduq1``viduq1：画面清晰，平滑转场，运镜稳定
imagesstring图像参考支持多张图片，模型将以此参数中传入的图片中的主题为参考生成具备主体一致的视频，各模型版本可参考图片数量不同，具体要求如下注1：viduq1系列模型支持上传 1～7 张图片，注2：支持传入图片 Base64 编码或图片URL（确保可访问）注3：图片支持 png、jpeg、jpg、webp格式注4：图片像素不能小于 128*128，且比例需要小于1:4或者4:1注5：请注意，http请求的post body不超过20MB，且编码必须包含适当的内容类型字符串，base64,{base64_encode}normal
data:image/pngpromptstring*文本提示词生成视频的文本描述。注：字符长度不能超过 5000 个字符。
bgmbooleanserver_idString通过创建主体API获取的 主体id注：不传server_id时，为临时主体，系统不保存
本次调用的视频时长参数
seedInt本次调用的随机种子参数
aspect_ratioString本次调用的 比例 参数
resolutionString本次调用的分辨率参数
bgmBool本次调用的背景音乐参数
movement_amplitudeString本次调用的镜头动态幅度参数
payloadString本次调用时传入的透传参数
off_peakBool本次调用时是否使用错峰模式
creditsInt本次调用使用的积分数
watermarkBool本次提交任务是否使用水印
created_atString任务创建时间
是否为生成的视频添加背景音乐。默认：false，可选值 true 、false- 传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加；不传或为 false 则不添加 BGM。- BGM不限制时长，系统根据视频时长自动适配- 该参数在q2系列模型的duration为 9秒 或 10秒 时不生效
durationinteger视频时长参数，默认值依据模型而定viduq1：默认5秒，可选：5
seedinteger随机种子当默认不传或者传0时，会使用随机数替代手动设置则使用设置的种子
aspect_ratiostring默认 16:9，可选值如下：1:1、9:16、16:9、3:4、4:3auto：根据输入图或视频自动推荐
movement_amplitudestring运动幅度默认 auto，可选值：auto、small、medium、large
resolutionstring分辨率参数，默认值依据模型和视频时长而定：viduq1 （5秒）：默认 1080p, 可选：1080p
movement_amplitudestring运动幅度默认 auto，可选值：auto、small、medium、large
payloadstring透传参数不做任何处理，仅数据传输注：最多 1048576个字符
off_peakboolean错峰模式，默认为：false，可选值：- true：错峰生成视频；- false：即时生成视频；注1：错峰模式消耗的积分更低，具体请查看产品定价注2：错峰模式下提交的任务，会在48小时内生成，未能完成的任务会被自动取消，并返还该任务的积分；注3：您也可以手动取消错峰任务注4：q1系列模型在audio为false时支持错峰任务
watermarkboolean是否添加水印- true：添加水印；- false：不添加水印；注1：目前水印内容为固定，内容由AI生成，默认不加注2：您可以通过watermarked_url参数查询获取带水印的视频内容，详情见查询任务接口
wm_positioninteger水印位置，表示水印出现在图片的位置，默认为：3，可选项为：1：左上角2：右上角3：右下角4：左下角
wm_urlstring水印内容，此处为图片URL不传时，使用默认水印：内容由AI生成
meta_datastring元数据标识，json格式字符串，透传字段，您可以 自定义格式 或使用 示例格式 ，示例如下：{"Label": "your_label","ContentProducer": "your_content_producer","ContentPropagator": "your_content_propagator","ProduceID": "your_product_id", "PropagateID": "your_propagate_id","ReservedCode1": "your_reserved_code1", "ReservedCode2": "your_reserved_code2"}该参数为空时，默认使用vidu生成的元数据标识
callback_urlstringCallback 协议需要您在创建任务时主动设置 callback_url，请求方法为 POST，当视频生成任务有状态变化时，Vidu 将向此地址发送包含任务最新状态的回调请求。回调请求内容结构与查询任务API的返回体一致回调返回的"status"包括以下状态：- processing 任务处理中- success 任务完成（如发送失败，回调三次）- failed 任务失败（如发送失败，回调三次）Vidu采用回调签名算法进行认证，详情见：回调签名算法
application/json返回参数
idstring任务ID
statestring处理状态
可选值：created 创建成功queueing 任务排队中processing 任务处理中success 任务成功failed 任务失败
err_codestring错误码，具体见错误码表
creditsinteger该任务消耗的积分数量，单位：积分
payloadstring本次任务调用时传入的透传参数
bgmboolean本次任务调用是否使用bgm
off_peakboolean本次任务调用是否使用错峰模式
creationsarray生成物结果
idstring生成物id，用来标识不同的生成物
urlstring生成物URL， 24小时有效期
cover_urlstring生成物封面，24小时有效期
watermarked_urlstringapplication/json返回参数
task_idstringVidu 生成的任务ID
statestring处理状态
可选值：
created 创建成功
queueing 任务排队中
processing 任务处理中
success 任务成功
failed 任务失败
modelstring本次调用的模型名称
promptstring本次调用的提示词参数
images带水印的生成物url，24小时有效期
本次调用的图像参数
durationinteger本次调用的视频时长参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
resolutionstring本次调用的分辨率参数
bgmboolean本次调用的背景音乐参数
movement_amplitudestring本次调用的镜头动态幅度参数
payloadstring本次调用时传入的透传参数
off_peakboolean本次调用时是否使用错峰模式
creditsinteger本次调用使用的积分数
watermarkboolean本次提交任务是否使用水印
created_atstring任务创建时间
curl --request POST \
--url 'https://api.vidu.cn/ent/v2/reference2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq1",
"images": "data:image/png",
"prompt": "Santa Claus and the bear hug by the lakeside.",
"bgm": true,
"duration": 5,
"seed": 0,
"aspect_ratio": "3:4",
"movement_amplitude": "string",
"resolution": "1080p",
"payload": "string",
"off_peak": true,
"watermark": true,
"wm_position": 0,
"wm_url": "string",
"meta_data": "string",
"callback_url": "string"
}' {
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq1",
"images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-1.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-2.png","https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/template/reference2video-3.png"],
"prompt": "Santa Claus and the bear hug by the lakeside.",
"duration": 5,
"seed": random_number,
"aspect_ratio": "3:4",
"resolution": "540p",
"movement_amplitude": "auto",
"payload":"",
"off_peak": false,
"credits":credits_number,
"created_at": "2025-01-01T15:41:31.968916Z"
}
{
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq1",
"images": [""],
"prompt": "[@1]和[@2]在[@3]一起吃火锅",
"duration": 5,
"seed": random_number,
"aspect_ratio": "3:4",
"resolution": "720p",
"audio": true,
"payload":"",
"off_peak": false,
"credits":credits_number,
"created_at": "2025-01-01T15:41:31.968916Z"
}curl --request GET \
--url 'https://api.vidu.cn/ent/v2/tasks/{your_id}/creations' \
--header 'Authorization: Token {your api key}'{
"id":"your_task_id",
"state": "success",
"err_code": "",
"credits": 4,
"payload": "",
"creations": [
{
"id": "your_creations_id",
"url": "your_generated_results_url",
"cover_url": "your_generated_results_cover_url",
"watermarked_url": "your_generated_results_watermarked_url"
}
]
} POST https://api.vidu.cn/ent/v2/reference2video