提交Vidu文生视频任务

最近更新时间:2026-04-16 02:41:47

我的收藏

1. 接口描述

接口请求域名: vclm.tencentcloudapi.com 。

提交Vidu文生视频任务接口

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:SubmitTextToVideoViduJob。
Version String 公共参数,本接口取值:2024-05-23。
Region String 公共参数,详见产品支持的 地域列表
Prompt String

文本提示词
生成视频的文本描述。
注:字符长度不能超过 2000 个字符


示例值:圣诞老人与熊在湖边相拥。
Model String

模型名称,可选值,默认viduq2

  • viduq2:最新模型
  • viduq3-turbo:对比viduq3-pro,生成速度更快
  • viduq3-pro:高效生成优质音视频内容,让视频内容更生动、更形象、更立体,效果更好

示例值:viduq2
Duration Integer

视频时长参数,默认值依据模型而定:

  • viduq3-pro、viduq3-turbo: 默认5秒,可选:1-16
  • viduq2 : 默认5秒,可选:1-10

示例值:5
Bgm Boolean

是否为生成的视频添加背景音乐。
默认:false,可选值 true 、false
传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加;不传或为 false 则不添加 BGM。

  • BGM不限制时长,系统根据视频时长自动适配
  • BGM参数在q2模型的duration为 9秒 或 10秒 时不生效;该参数在q3系列模型中不生效

示例值:true
AspectRatio String

比例
默认 16:9,可选值如下:16:9、9:16、4:3、3:4、1:1


示例值:16:9
Resolution String

分辨率参数,默认值依据模型和视频时长而定:

  • viduq3-pro、viduq3-turbo(1-16秒):默认 720p,可选:540p、720p、1080p
  • viduq2(1-10秒):默认 720p,可选:540p、720p、1080p

示例值:720p
Style String

风格
默认 general,可选值:general、anime
general:通用风格,可以通过提示词来控制风格
anime:动漫风格,仅在动漫风格表现突出,可以通过不同的动漫风格提示词来控制
注:使用q2、q3系列模型时该参数不生效


示例值:general
MovementAmplitude String

运动幅度
默认 auto,可选值:auto、small、medium、large
注:使用q2、q3系列模型时该参数不生效


示例值:auto
Audio Boolean

是否使用音视频直出能力,默认为true,枚举值为:

  • false:不需要音视频直出,输出静音视频
  • true:需要音画同步,输出声音的视频(包括台词和音效)
    注1:仅q3系列模型支持该参数

示例值:true
MetaData 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生成的元数据标识


示例值:string
CallbackUrl String

Callback 协议
需要您在创建任务时主动设置 callback_url,请求方法为 POST,当视频生成任务完成时,将向此地址发送包含任务最新状态的回调请求。回调请求内容结构与查询任务API的返回体一致
回调返回的"status"包括以下状态:

  • success 任务完成(如发送失败,回调三次)
  • failed 任务失败(如发送失败,回调三次)

示例值:string
Payload String

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


示例值:string
OffPeak Boolean

错峰模式,默认为:false,可选值:

  • true:错峰生成视频;
  • false:即时生成视频;
    注1:错峰模式消耗的积分更低
    注2:错峰模式下提交的任务,会在48小时内生成,未能完成的任务会被自动取消,并返还该任务的积分

示例值:true
LogoAdd Integer

为生成结果图添加显式水印标识的开关,默认为1。
1:添加。
0:不添加。
其他数值:默认按1处理。
建议您使用显著标识来提示结果图使用了 AI 绘画技术,是 AI 生成的图片。
示例值:1


示例值:1
LogoParam LogoParam

标识内容设置。
默认在生成结果图右下角添加“图片由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。

3. 输出参数

参数名称 类型 描述
JobId String

任务ID。


示例值:1383331701135622144
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用示例

输入示例

POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitTextToVideoViduJob
<公共请求参数>

{
    "Prompt": "圣诞老人与熊在湖边相拥。"
}

输出示例

{
    "Response": {
        "JobId": "1384470610896863232",
        "RequestId": "76d0ba5a-268c-4e43-b254-34872439e48a"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码