Q3 创建任务
POST
/ent/v2/reference2videoQ3 查询生成物
GET
/ent/v2/tasks/{id}/creationsVidu Q-视频模型
创建主体方法:https://platform.vidu.cn/docs/subjects
modelstring*模型名称,可选值:viduq3,支持智能切镜,多机位的一致性更出色,支持音画同出
viduq3auto_subjectsbooleanAuthorizationstring*将 {your api key} 替换为您的 token
Token {your api key}idstring*任务id,由创建任务接口创建成功返回
Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}modelstring*模型名称,可选值:viduq3-turbo:支持智能切镜,支持音画同出,生成速度更快,性价比高
imagesarrayAuthorizationstring*将 {your api key} 替换为您的 token
Token {your api key}idstring*任务id,由创建任务接口创建成功返回
Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}modelstring*模型名称,可选值:viduq3-drama:漫剧行业微调模型,为剧而生!
imagesarrayAuthorizationstring*将 {your api key} 替换为您的 token
Token {your api key}idstring*任务id,由创建任务接口创建成功返回
Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}modelstring*模型名称,可选值:viduq3-mix:画面质感强,支持智能切镜,支持音画同出,动态效果好,均衡性强
viduq3-miximagesarrayAuthorizationstring*将 {your api key} 替换为您的 token
Token {your api key}idstring*任务id,由创建任务接口创建成功返回
Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}modelstring*模型名称,可选值:viduq3-ad:广告行业微调模型,为广告而生!
viduq3-adimagesarrayAuthorizationstring*将 {your api key} 替换为您的 token
Token {your api key}idstring*任务id,由创建任务接口创建成功返回
falsetruefalsesubjectsarray<object>*namestring*用户指定的主体名称(name),生成时可以通过[@name]的方式使用,例如:[@图1]
imagespromptstring*[@subjects_name] 来表示主体内容,例如:"@1 和 @2 在一起吃火锅,并且旁白音说火锅大家都爱吃。"audiobooleantruetruefalsedurationinteger视频时长参数
53 - 16seedinteger随机种子,当默认不传或者传0时,会使用随机数替代手动设置则使用设置的种子
0aspect_ratiostring16:91:116:99:163:44:3autoresolutionstring视频分辨率参数
720p540p720p1080ppayloadstringwatermarkbooleanwm_positioninteger31234wm_urlstring水印内容,此处为图片URL不传时,使用默认水印:内容由AI生成
meta_datastringcallback_urlstringtask_idstringVidu 生成的任务ID
statestringcreated 创建成功queueing 任务排队中processing 任务处理中success 任务成功Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}modelstring*模型名称,可选值:viduq3,支持智能切镜,支持音画同出,多机位的一致性更出色
viduq3imagesarray*data:image/png;base64,{base64_encode}data:image/pngpromptstring*文本提示词生成视频的文本描述。注:字符长度不能超过 5000 个字符。
durationinteger视频时长参数,默认值依据模型而定viduq3-turbo:默认5秒,可选3 - 15
seedinteger随机种子当默认不传或者传0时,会使用随机数替代手动设置则使用设置的种子
aspect_ratiostring默认 16:9,可选值如下:1:1、9:16、16:9、3:4、4:3auto:根据输入图或视频自动推荐
resolutionstring分辨率参数,默认值依据模型和视频时长而定:viduq3-turbo(3-16秒):默认 720p, 可选:540p、720p、1080p
payloadstring透传参数不做任何处理,仅数据传输注:最多 1048576个字符
off_peakboolean错峰模式,默认为:false,可选值:- true:错峰生成视频;- false:即时生成视频;注1:错峰模式消耗的积分更低,具体请查看产品定价注2:错峰模式下提交的任务,会在48小时内生成,未能完成的任务会被自动取消,并返还该任务的积分;注3:您也可以手动取消错峰任务
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采用回调签名算法进行认证,详情见:回调签名算法
data:image/png;base64,{base64_encode}data:image/pngsoundsarraydata:video/mp3;base64,{base64_encode}data:video/mp3promptstring*durationinteger视频时长参数
82 - 16seedinteger随机种子,当默认不传或者传0时,会使用随机数替代手动设置则使用设置的种子
0aspect_ratiostring16:99:16autoresolutionstring视频分辨率参数
1080p720p1080paudiobooleantruetruefalsepayloadstringwatermarkbooleantruetruefalsewm_positioninteger31234wm_urlstring水印内容,此处为图片URL不传时,使用默认水印:内容由AI生成
meta_datastringcallback_urlstringdata:image/png;base64,{base64_encode}data:image/pngpromptstring*durationinteger视频时长参数
53 - 15seedinteger随机种子,当默认不传或者传0时,会使用随机数替代手动设置则使用设置的种子
aspect_ratiostring16:91:116:99:163:44:3autoresolutionstring视频分辨率参数
720p720p1080ppayloadstringwatermarkbooleantruetruefalsewm_positioninteger31234wm_urlstring水印内容,此处为图片URL不传时,使用默认水印:内容由AI生成
meta_datastringcallback_urlstringdata:image/png;base64,{base64_encode}data:image/pngpromptstring*durationinteger视频时长参数
53 - 15seedinteger随机种子,当默认不传或者传0时,会使用随机数替代手动设置则使用设置的种子
0aspect_ratiostring16:91:116:99:163:44:3autoresolutionstring输出视频分辨率参数
720p720p1080ppayloadstringwatermarkbooleantruetruefalsewm_positioninteger31234wm_urlstring水印内容,此处为图片URL不传时,使用默认水印:内容由AI生成
meta_datastringcallback_urlstringdata:image/png;base64,{base64_encode}server_idstringfailedmodelstring本次调用的模型名称
promptstring本次调用的提示词参数
imagesarray本次调用的图像参数
durationinteger本次调用的视频时长参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
resolutionstring本次调用的分辨率参数
payloadstring本次调用时传入的透传参数
off_peakboolean本次调用时是否使用错峰模式
creditsinteger本次调用使用的积分数
watermarkboolean本次提交任务是否使用水印
created_atstring任务创建时间
data:image/png;base64,{base64_encode}data:image/pngpromptstring*audiobooleantruetruefalsedurationinteger视频时长参数
53 - 16seedinteger随机种子当默认不传或者传0时,会使用随机数替代手动设置则使用设置的种子
0aspect_ratiostring视频比例参数,auto 指任意自定义比例
16:91:116:99:163:44:3autoresolutionstring输出视频的分辨率参数
720p540p720p1080ppayloadstringwatermarkbooleantruetruefalsewm_positioninteger31234wm_urlstring水印内容,此处为图片URL,不传时,使用默认水印:内容由AI生成
meta_datastringcallback_urlstringapplication/json返回参数
idstring任务ID
statestring处理状态
可选值:created 创建成功queueing 任务排队中processing 任务处理中success 任务成功failed 任务失败
err_codestring错误码,具体见错误码表
application/json返回参数
idstring任务ID
statestring处理状态
可选值:created 创建成功queueing 任务排队中processing 任务处理中success 任务成功failed 任务失败
err_codestring错误码,具体见错误码表
application/json返回参数
idstring任务ID
statestringcreated 创建成功queueing 任务排队中processing 任务处理中application/json返回参数
idstring任务ID
statestringcreated 创建成功queueing 任务排队中processing 任务处理中application/json返回参数
idstring任务ID
statestringcreated 创建成功queueing 任务排队中processing 任务处理中creditsinteger该任务消耗的积分数量,单位:积分
payloadstring本次任务调用时传入的透传参数
off_peakboolean本次任务调用是否使用错峰模式
creationsarray生成物结果
idstring生成物id,用来标识不同的生成物
urlstring生成物URL, 24小时有效期
cover_urlstring生成物封面,24小时有效期
watermarked_urlstringcreditsinteger该任务消耗的积分数量,单位:积分
payloadstring本次任务调用时传入的透传参数
bgmboolean本次任务调用是否使用bgm
off_peakboolean本次任务调用是否使用错峰模式
creationsarray生成物结果
idstring生成物id,用来标识不同的生成物
urlstring生成物URL, 24小时有效期
cover_urlstring生成物封面,24小时有效期
watermarked_urlstringsuccess 任务成功failed 任务失败err_codestring错误码,具体见错误码表
creditsinteger该任务消耗的积分数量,单位:积分
payloadstring本次任务调用时传入的透传参数
off_peakboolean本次任务调用是否使用错峰模式
creationsarray生成物结果
idstring生成物id,用来标识不同的生成物
urlstring生成物URL, 24小时有效期
cover_urlstring生成物封面,24小时有效期
watermarked_urlstringsuccess 任务成功failed 任务失败err_codestring错误码,具体见错误码表
creditsinteger该任务消耗的积分数量,单位:积分
payloadstring本次任务调用时传入的透传参数
off_peakboolean本次任务调用是否使用错峰模式
creationsarray生成物结果
idstring生成物id,用来标识不同的生成物
urlstring生成物URL, 24小时有效期
cover_urlstring生成物封面,24小时有效期
watermarked_urlstringsuccess 任务成功failed 任务失败err_codestring错误码,具体见错误码表
creditsinteger该任务消耗的积分数量,单位:积分
payloadstring本次任务调用时传入的透传参数
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本次调用的提示词参数
imagesapplication/json返回参数
task_idstringVidu 生成的任务ID
statestring处理状态
可选值:
created 创建成功
queueing 任务排队中
processing 任务处理中
success 任务成功
failed 任务失败
modelstring本次调用的模型名称
promptstring本次调用的提示词参数
imagesapplication/json返回参数
task_idstringVidu 生成的任务ID
statestringcreated 创建成功queueing 任务排队中processing 任务处理中application/json返回参数
task_idstringVidu 生成的任务ID
statestringcreated 创建成功queueing 任务排队中processing 任务处理中application/json返回参数
task_idstringVidu 生成的任务ID
statestring处理状态
可选值:
created 创建成功
queueing 任务排队中
processing 任务处理中
success 任务成功
failed 任务失败
modelstring本次调用的模型名称
promptstring本次调用的提示词参数
images带水印的生成物url,24小时有效期
带水印的生成物url,24小时有效期
带水印的生成物url,24小时有效期
带水印的生成物url,24小时有效期
带水印的生成物url,24小时有效期
本次调用的图像参数
durationinteger本次调用的视频时长参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
resolutionstring本次调用的分辨率参数
bgmboolean本次调用的背景音乐参数
movement_amplitudestring本次调用的镜头动态幅度参数
payloadstring本次调用时传入的透传参数
off_peakboolean本次调用时是否使用错峰模式
creditsinteger本次调用使用的积分数
watermarkboolean本次提交任务是否使用水印
created_atstring任务创建时间
本次调用的图像参数
durationinteger本次调用的视频时长参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
resolutionstring本次调用的分辨率参数
bgmboolean本次调用的背景音乐参数
movement_amplitudestring本次调用的镜头动态幅度参数
payloadstring本次调用时传入的透传参数
off_peakboolean本次调用时是否使用错峰模式
creditsinteger本次调用使用的积分数
watermarkboolean本次提交任务是否使用水印
created_atstring任务创建时间
success 任务成功failed 任务失败modelstring本次调用的模型名称
promptstring本次调用的提示词参数
imagesstring本次调用的图像参数
durationinteger本次调用的视频时长参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
resolutionstring本次调用的分辨率参数
payloadstring本次调用时传入的透传参数
creditsinteger本次调用使用的积分数
watermarkboolean本次提交任务是否使用水印
created_atstring任务创建时间
success 任务成功failed 任务失败modelstring本次调用的模型名称
promptstring本次调用的提示词参数
imagesarray本次调用的图像参数
durationinteger本次调用的视频时长参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
resolutionstring本次调用的分辨率参数
payloadstring本次调用时传入的透传参数
creditsinteger本次调用使用的积分数
watermarkboolean本次提交任务是否使用水印
created_atstring任务创建时间
本次调用的图像参数
durationinteger本次调用的视频时长参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
resolutionstring本次调用的分辨率参数
payloadstring本次调用时传入的透传参数
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": "viduq3",
"images": "data:image/png",
"prompt": "Santa Claus and the bear hug by the lakeside.",
"audio": true,
"duration": 5,
"seed": 0,
"aspect_ratio": "16:9",
"resolution": "720p",
"payload": "string",
"off_peak": false,
"watermark": true,
"wm_position": 3,
"wm_url": "string",
"meta_data": "string",
"callback_url": "string"
}' {
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq3",
"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": "viduq3",
"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"
}
]
}curl --request POST \
--url 'https://api.vidu.cn/ent/v2/reference2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-turbo",
"images": "data:image/png",
"prompt": "Santa Claus and the bear hug by the lakeside.",
"duration": 5,
"seed": 0,
"aspect_ratio": "3:4",
"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": "viduq3-turbo",
"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": "viduq3-turbo",
"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"
}
]
}curl --request POST \
--url 'https://api.vidu.cn/ent/v2/reference2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-drama",
"images": "data:image/png",
"sounds": "data:video/mp3",
"prompt": "Santa Claus and the bear hug by the lakeside.",
"duration": 8,
"seed": 0,
"aspect_ratio": "16:9",
"resolution": "1080p",
"audio": true,
"payload": "string",
"watermark": true,
"wm_position": 3,
"wm_url": "string",
"meta_data": "string",
"callback_url": "string"
}' {
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq3-drama",
"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,
"aspect_ratio": "16:9",
"resolution": "720p",
"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"
}
]
}curl --request POST \
--url 'https://api.vidu.cn/ent/v2/reference2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-mix",
"images": "data:image/png",
"prompt": "Santa Claus and the bear hug by the lakeside.",
"duration": 5,
"seed": 0,
"aspect_ratio": "16:9",
"resolution": "720p",
"payload": "string",
"watermark": true,
"wm_position": 3,
"wm_url": "string",
"meta_data": "string",
"callback_url": "string"
}' {
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq3-mix",
"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": "720p",
"payload":"",
"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"
}
]
}curl --request POST \
--url 'https://api.vidu.cn/ent/v2/reference2video' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"model": "viduq3-ad",
"images": "data:image/png",
"prompt": "Santa Claus and the bear hug by the lakeside.",
"duration": 5,
"seed": 0,
"aspect_ratio": "16:9",
"resolution": "720p",
"payload": "string",
"watermark": true,
"wm_position": 3,
"wm_url": "string",
"meta_data": "string",
"callback_url": "string"
}' {
"task_id": "your_task_id_here",
"state": "created",
"model": "viduq3-ad",
"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": "16:9",
"resolution": "720p",
"payload":"",
"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