1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
提交Vidu文生视频任务接口
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitTextToVideoViduJob。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Prompt | 是 | String | 文本提示词 示例值:圣诞老人与熊在湖边相拥。 |
| Model | 否 | String | 模型名称,可选值,默认viduq2
示例值:viduq2 |
| Duration | 否 | Integer | 视频时长参数,默认值依据模型而定:
示例值:5 |
| Bgm | 否 | Boolean | 是否为生成的视频添加背景音乐。
示例值:true |
| AspectRatio | 否 | String | 比例 示例值:16:9 |
| Resolution | 否 | String | 分辨率参数,默认值依据模型和视频时长而定:
示例值:720p |
| Style | 否 | String | 风格 示例值:general |
| MovementAmplitude | 否 | String | 运动幅度 示例值:auto |
| Audio | 否 | Boolean | 是否使用音视频直出能力,默认为true,枚举值为:
示例值:true |
| MetaData | 否 | String | 元数据标识,json格式字符串,透传字段,您可以 自定义格式 或使用 示例格式 ,示例如下: 示例值:string |
| CallbackUrl | 否 | String | Callback 协议
示例值:string |
| Payload | 否 | String | 透传参数 不做任何处理,仅数据传输 注:最多 1048576个字符 示例值:string |
| OffPeak | 否 | Boolean | 错峰模式,默认为:false,可选值:
示例值:true |
| LogoAdd | 否 | Integer | 为生成结果图添加显式水印标识的开关,默认为1。 示例值:1 |
| LogoParam | 否 | LogoParam | 标识内容设置。 |
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。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。