创建任务
POST
/ent/v2/template查询生成物
GET
/ent/v2/tasks/{id}/creations一键解决方案
Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}imagesstring*图像
模型将以此参数中传入的图片来生成视频。
注1:支持传入图片 Base64 编码或图片URL(确保可访问)
注2:图片支持 png、jpeg、jpg、webp格式
注3:图片比例需要小于 1:4 或者 4:1 ;
注4:图片大小不超过 50 MB;
注5:请注意,http请求的post body不超过20MB,且编码必须包含适当的内容类型字符串,base64,{base64_encode}normal
data:image/pngpromptstring文本提示词
生成视频的文本描述,字符长度不超过 2000 字符。
注:当 template= subject_3、pubg_winner_hit时,提示词非必传
Video content\n画面中的两个主体转向彼此,并开始拥抱# 要求\n将Motion Level设置为‘Large’seedinteger随机种子
当默认不传或者传0时,会使用随机数替代
手动设置则使用设置的种子
0aspect_ratiostring比例
默认 16:9,可选值如下:16:9、9:16
\* 不同 template 支持的可选值不同,详情见模版说明
areastring异域公主特效专属参数
仅当 template 传 exotic_princess 时可用,可选值如下:
默认:auto, 可选:denmark,uk,africa,china,mexico,switzerland,russia,italy,korea,thailand,india,japan
beaststring与兽同行特效专属参数
仅当 template 传 beast_companion 时可用,可选值如下:
默认 auto,可选:bear,tiger,elk,snake,lion,wolf
bgmboolean是否为生成的视频添加背景音乐。
默认:false,可选值 true 、false
payloadstring透传参数
不做任何处理,仅数据传输
注:最多 1048576个字符
watermarkboolean是否添加水印
wm_positioninteger水印位置,表示水印出现在图片的位置,可选项为:1:左上角2:右上角3:右下角4:左下角
默认为:3
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 任务失败(如发送失败,回调三次)Authorizationstring*将 {your api key} 替换为您的 token
Token {your api key}idstring*路径参数,任务的唯一标识(ID)。
{your_id}idstring*任务id,由创建任务接口创建成功返回
curl --request POST \
--url 'https://api.vidu.cn/ent/v2/template' \
--header 'Authorization: Token {your api key}' \
--header 'Content-Type: application/json' \
--data '{
"template": "hugging",
"images": "data:image/png",
"prompt": "Video content\\n画面中的两个主体转向彼此,并开始拥抱# 要求\\n将Motion Level设置为‘Large’",
"seed": 0,
"aspect_ratio": "string",
"area": "string",
"beast": "string",
"bgm": true,
"payload": "string",
"watermark": true,
"wm_position": 0,
"wm_url": "string",
"meta_data": "string",
"callback_url": "string"
}'{
"task_id": "your_task_id_here",
"state": "created",
"template": "hug",
"images": ["https://prod-ss-images.s3.cn-northwest-1.amazonaws.com.cn/vidu-maas/scene-template/hug.jpeg"],
"prompt": "hug",
"seed": random_number,
"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}' \
--header 'Content-Type: application/json'{
"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"
}
]
}application/json返回参数
task_idstringVidu 生成的任务ID
statestring处理状态
可选值:created 创建成功queueing 任务排队中processing 任务处理中success 任务成功failed 任务失败
templatestring本次调用的场景参数
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_urlstring带水印的生成物url,24小时有效期
promptstring本次调用的提示词参数
imagesstring本次调用的图像参数
seedinteger本次调用的随机种子参数
aspect_ratiostring本次调用的 比例 参数
bgmboolean本次调用的背景音乐参数
payloadstring本次调用时传入的透传参数
watermarkboolean本次调用是否使用水印
creditsinteger本次调用使用的积分数
created_atstring任务创建时间