1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
通过提交对视频内容的描述文本生成一个短视频。文生视频为异步处理任务,成功提交任务后返回任务的JobId。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitTextToVideoJob。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Prompt | 否 | String | 正向文本提示词。不能超过2500个字符 示例值:一只兔子在草地奔跑 |
| Model | 否 | String | 模型名称。 示例值:v1.6 |
| NegativePrompt | 否 | String | 负向文本提示词。不能超过2500个字符 示例值:模糊 |
| Duration | 否 | String | 生成视频时长,单位s。默认值为5。 不同模型支持时长不同
示例值:5 |
| Mode | 否 | String | 生成视频的模式; 枚举值:std,pro
不同模型版本、视频模式支持范围不同
示例值:std |
| CfgScale | 否 | Float | 生成视频的自由度;值越大,模型自由度越小,与用户输入的提示词相关性越强。 示例值:0.5 |
| AspectRatio | 否 | String | 生成视频的画面纵横比(宽:高) 示例值:16:9 |
| Sound | 否 | String | 生成视频时是否同时生成声音
仅V2.6及后续版本模型支持当前参数,v2.6模型的std模式只能生成无声的视频 示例值:off |
| LogoAdd | 否 | Integer | 为生成视频添加标识的开关,默认为1。 示例值:0 |
| LogoParam | 否 | LogoParam | 标识内容设置。 |
| MultiShot | 否 | Boolean | 是否生成多镜头视频
示例值:true |
| ShotType | 否 | String | 分镜方式 枚举值:customize,intelligence 示例值:customize |
| MultiPrompt.N | 否 | Array of MultiPrompt | 各分镜提示词,可包含正向描述和负向描述 通过index、prompt、duration参数定义分镜序号及相应提示词和时长,其中:
|
| CameraControl | 否 | CameraControl | 控制摄像机运动的协议(如未指定,模型将根据输入的文本/图片进行智能匹配) |
| CallbackUrl | 否 | String | 本次任务结果回调通知地址,如果配置,服务端会在任务状态发生变更时主动通知 示例值:https://callback.com |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务ID。 示例值:1194931538865782784 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交文生视频任务
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitTextToVideoJob
<公共请求参数>
{
"Prompt": "一只兔子在草原上奔跑"
}
输出示例
{
"Response": {
"JobId": "1339558839695589376",
"RequestId": "e44cc7dc-7e0f-4c45-bfd6-48d817130edd"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。