场景特效模版

当前页面

字段	值	描述
Content-Type	application/json	数据交换格式
Authorization	Token {your api key}	将 {your api key} 替换为您的 token

字段

值

描述

Content-Type

application/json

数据交换格式

Authorization

Token {your api key}

将 {your api key} 替换为您的 token

参数名称	类型	必填	参数描述
template	String	是	场景模版参数不同的场景模板，对应的调用参数不同，我们提供两种查看方式：官网示例中心：场景示例中心文档（支持按上线时间查询）：场景示例中心文档
images	Array[String]	是	图像模型将以此参数中传入的图片来生成视频。注1：支持传入图片 Base64 编码或图片URL（确保可访问）注2：图片支持 png、jpeg、jpg、webp格式注3：图片比例需要小于 1:4 或者 4:1 ；注4：图片大小不超过 50 MB；注5：请注意，http请求的post body不超过20MB，且编码必须包含适当的内容类型字符串，例如： `data:image/png;base64,{base64_encode}`
prompt	String	可选	文本提示词生成视频的文本描述，字符长度不超过 2000 字符。注：当 template= subject_3、pubg_winner_hit时，提示词非必传
seed	Int	可选	随机种子当默认不传或者传0时，会使用随机数替代手动设置则使用设置的种子
aspect_ratio	String	可选	比例默认 16:9，可选值如下：16:9、9:16 * 不同 template 支持的可选值不同，详情见模版说明
area	String	可选	异域公主特效专属参数仅当 template 传 exotic_princess 时可用，可选值如下：默认：auto, 可选：denmark,uk,africa,china,mexico,switzerland,russia,italy,korea,thailand,india,japan
beast	String	可选	与兽同行特效专属参数仅当 template 传 beast_companion 时可用，可选值如下：默认 auto,可选：bear,tiger,elk,snake,lion,wolf
bgm	Bool	可选	是否为生成的视频添加背景音乐。默认：false，可选值 true 、false - 传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加；不传或为 false 则不添加 BGM。 - BGM不限制时长，系统根据视频时长自动适配
payload	String	可选	透传参数不做任何处理，仅数据传输注：最多 1048576个字符
watermark	Bool	可选	是否添加水印 - true：添加水印； - false：不添加水印；注1：目前水印内容为固定，内容由AI生成，默认不加注2：您可以通过watermarked_url参数查询获取带水印的视频内容，详情见查询任务接口
wm_position	Int	可选	水印位置，表示水印出现在图片的位置，可选项为： 1：左上角 2：右上角 3：右下角 4：左下角默认为：3
wm_url	String	可选	水印内容，此处为图片URL 不传时，使用默认水印：内容由AI生成
meta_data	String	可选	元数据标识，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_url	String	可选	Callback 协议需要您在创建任务时主动设置 callback_url，请求方法为 POST，当视频生成任务有状态变化时，Vidu 将向此地址发送包含任务最新状态的回调请求。回调请求内容结构与查询任务API的返回体一致回调返回的"status"包括以下状态： - processing 任务处理中 - success 任务完成（如发送失败，回调三次） - failed 任务失败（如发送失败，回调三次） Vidu采用回调签名算法进行认证，详情见：回调签名算法

参数名称

类型

必填

参数描述

template

String

是

场景模版参数
不同的场景模板，对应的调用参数不同，我们提供两种查看方式：
官网示例中心：场景示例中心
文档（支持按上线时间查询）：场景示例中心文档

images

Array[String]

是

图像
模型将以此参数中传入的图片来生成视频。
注1：支持传入图片 Base64 编码或图片URL（确保可访问）
注2：图片支持 png、jpeg、jpg、webp格式
注3：图片比例需要小于 1:4 或者 4:1 ；
注4：图片大小不超过 50 MB；
注5：请注意，http请求的post body不超过20MB，且编码必须包含适当的内容类型字符串，例如：

data:image/png;base64,{base64_encode}

prompt

String

可选

文本提示词
生成视频的文本描述，字符长度不超过 2000 字符。
注：当 template= subject_3、pubg_winner_hit时，提示词非必传

seed

Int

可选

随机种子
当默认不传或者传0时，会使用随机数替代
手动设置则使用设置的种子

aspect_ratio

String

可选

比例
默认 16:9，可选值如下：16:9、9:16
* 不同 template 支持的可选值不同，详情见模版说明

area

String

可选

异域公主特效专属参数
仅当 template 传 exotic_princess 时可用，可选值如下：
默认：auto, 可选：denmark,uk,africa,china,mexico,switzerland,russia,italy,korea,thailand,india,japan

beast

String

可选

与兽同行特效专属参数
仅当 template 传 beast_companion 时可用，可选值如下：
默认 auto,可选：bear,tiger,elk,snake,lion,wolf

bgm

Bool

可选

是否为生成的视频添加背景音乐。
默认：false，可选值 true 、false
- 传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加；不传或为 false 则不添加 BGM。
- BGM不限制时长，系统根据视频时长自动适配

payload

String

可选

透传参数
不做任何处理，仅数据传输
注：最多 1048576个字符

watermark

Bool

可选

是否添加水印
- true：添加水印；
- false：不添加水印；
注1：目前水印内容为固定，内容由AI生成，默认不加
注2：您可以通过watermarked_url参数查询获取带水印的视频内容，详情见查询任务接口

wm_position

Int

可选

水印位置，表示水印出现在图片的位置，可选项为：
1：左上角
2：右上角
3：右下角
4：左下角
默认为：3

wm_url

String

可选

水印内容，此处为图片URL
不传时，使用默认水印：内容由AI生成

meta_data

String

可选

元数据标识，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_url

String

可选

Callback 协议
需要您在创建任务时主动设置 callback_url，请求方法为 POST，当视频生成任务有状态变化时，Vidu 将向此地址发送包含任务最新状态的回调请求。回调请求内容结构与查询任务API的返回体一致
回调返回的"status"包括以下状态：
- processing 任务处理中
- success 任务完成（如发送失败，回调三次）
- failed 任务失败（如发送失败，回调三次）
Vidu采用回调签名算法进行认证，详情见：回调签名算法

字段	类型	描述
task_id	String	Vidu 生成的任务ID
state	String	处理状态可选值： created 创建成功 queueing 任务排队中 processing 任务处理中 success 任务成功 failed 任务失败
template	String	本次调用的场景参数
prompt	String	本次调用的提示词参数
images	Array[String]	本次调用的图像参数
seed	Int	本次调用的随机种子参数
aspect_ratio	String	本次调用的比例参数
bgm	Bool	本次调用的背景音乐参数
payload	String	本次调用时传入的透传参数
watermark	Bool	本次调用是否使用水印
credits	Int	本次调用使用的积分数
created_at	String	任务创建时间

字段

类型

描述

task_id

String

Vidu 生成的任务ID

state

String

处理状态
可选值：
created 创建成功
queueing 任务排队中
processing 任务处理中
success 任务成功
failed 任务失败

template

String

本次调用的场景参数

prompt

String

本次调用的提示词参数

images

Array[String]

本次调用的图像参数

seed

Int

本次调用的随机种子参数

aspect_ratio

String

本次调用的比例参数

bgm

Bool

本次调用的背景音乐参数

payload

String

本次调用时传入的透传参数

watermark

Bool

本次调用是否使用水印

credits

Int

本次调用使用的积分数

created_at

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"
}

字段	值	描述
Content-Type	application/json	数据交换格式
Authorization	Token {your api key}	将 {your api key} 替换为您的 token

字段

值

描述

Content-Type

application/json

数据交换格式

Authorization

Token {your api key}

将 {your api key} 替换为您的 token

参数名称	类型	必填	参数描述
template	String	是	场景模版参数不同的场景模板，对应的调用参数不同，我们提供两种查看方式：官网示例中心：场景示例中心文档（支持按上线时间查询）：场景示例中心文档
images	Array[String]	是	图像模型将以此参数中传入的图片来生成视频。注1：支持传入图片 Base64 编码或图片URL（确保可访问）注2：图片支持 png、jpeg、jpg、webp格式注3：图片比例需要小于 1:4 或者 4:1 ；注4：图片大小不超过 50 MB；注5：请注意，http请求的post body不超过20MB，且编码必须包含适当的内容类型字符串，例如： `data:image/png;base64,{base64_encode}`
prompt	String	可选	文本提示词生成视频的文本描述，字符长度不超过 2000 字符。注：当 template= subject_3、pubg_winner_hit时，提示词非必传
seed	Int	可选	随机种子当默认不传或者传0时，会使用随机数替代手动设置则使用设置的种子
aspect_ratio	String	可选	比例默认 16:9，可选值如下：16:9、9:16 * 不同 template 支持的可选值不同，详情见模版说明
area	String	可选	异域公主特效专属参数仅当 template 传 exotic_princess 时可用，可选值如下：默认：auto, 可选：denmark,uk,africa,china,mexico,switzerland,russia,italy,korea,thailand,india,japan
beast	String	可选	与兽同行特效专属参数仅当 template 传 beast_companion 时可用，可选值如下：默认 auto,可选：bear,tiger,elk,snake,lion,wolf
bgm	Bool	可选	是否为生成的视频添加背景音乐。默认：false，可选值 true 、false - 传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加；不传或为 false 则不添加 BGM。 - BGM不限制时长，系统根据视频时长自动适配
payload	String	可选	透传参数不做任何处理，仅数据传输注：最多 1048576个字符
watermark	Bool	可选	是否添加水印 - true：添加水印； - false：不添加水印；注1：目前水印内容为固定，内容由AI生成，默认不加注2：您可以通过watermarked_url参数查询获取带水印的视频内容，详情见查询任务接口
wm_position	Int	可选	水印位置，表示水印出现在图片的位置，可选项为： 1：左上角 2：右上角 3：右下角 4：左下角默认为：3
wm_url	String	可选	水印内容，此处为图片URL 不传时，使用默认水印：内容由AI生成
meta_data	String	可选	元数据标识，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_url	String	可选	Callback 协议需要您在创建任务时主动设置 callback_url，请求方法为 POST，当视频生成任务有状态变化时，Vidu 将向此地址发送包含任务最新状态的回调请求。回调请求内容结构与查询任务API的返回体一致回调返回的"status"包括以下状态： - processing 任务处理中 - success 任务完成（如发送失败，回调三次） - failed 任务失败（如发送失败，回调三次） Vidu采用回调签名算法进行认证，详情见：回调签名算法

参数名称

类型

必填

参数描述

template

String

是

images

Array[String]

是

data:image/png;base64,{base64_encode}

prompt

String

可选

文本提示词
生成视频的文本描述，字符长度不超过 2000 字符。
注：当 template= subject_3、pubg_winner_hit时，提示词非必传

seed

Int

可选

随机种子
当默认不传或者传0时，会使用随机数替代
手动设置则使用设置的种子

aspect_ratio

String

可选

比例
默认 16:9，可选值如下：16:9、9:16
* 不同 template 支持的可选值不同，详情见模版说明

area

String

可选

beast

String

可选

与兽同行特效专属参数
仅当 template 传 beast_companion 时可用，可选值如下：
默认 auto,可选：bear,tiger,elk,snake,lion,wolf

bgm

Bool

可选

payload

String

可选

透传参数
不做任何处理，仅数据传输
注：最多 1048576个字符

watermark

Bool

可选

wm_position

Int

可选

水印位置，表示水印出现在图片的位置，可选项为：
1：左上角
2：右上角
3：右下角
4：左下角
默认为：3

wm_url

String

可选

水印内容，此处为图片URL
不传时，使用默认水印：内容由AI生成

meta_data

String

可选

callback_url

String

可选

字段	类型	描述
task_id	String	Vidu 生成的任务ID
state	String	处理状态可选值： created 创建成功 queueing 任务排队中 processing 任务处理中 success 任务成功 failed 任务失败
template	String	本次调用的场景参数
prompt	String	本次调用的提示词参数
images	Array[String]	本次调用的图像参数
seed	Int	本次调用的随机种子参数
aspect_ratio	String	本次调用的比例参数
bgm	Bool	本次调用的背景音乐参数
payload	String	本次调用时传入的透传参数
watermark	Bool	本次调用是否使用水印
credits	Int	本次调用使用的积分数
created_at	String	任务创建时间

字段

类型

描述

task_id

String

Vidu 生成的任务ID

state

String

处理状态
可选值：
created 创建成功
queueing 任务排队中
processing 任务处理中
success 任务成功
failed 任务失败

template

String

本次调用的场景参数

prompt

String

本次调用的提示词参数

images

Array[String]

本次调用的图像参数

seed

Int

本次调用的随机种子参数

aspect_ratio

String

本次调用的比例参数

bgm

Bool

本次调用的背景音乐参数

payload

String

本次调用时传入的透传参数

watermark

Bool

本次调用是否使用水印

credits

Int

本次调用使用的积分数

created_at

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"
}

接口文档

接口文档

创建视频任务

创建视频任务