1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
图生视频通用能力接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitImageToVideoGeneralJob。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Image | 是 | Image | 输入图片 Base64 和 Url 必须提供一个,如果都提供以ImageUrl为准。 上传图url大小不超过 8M 支持jpg,png,jpeg,webp,bmp,tiff 格式 单边分辨率不超过5000,不小于50,长宽限制1:4 ~ 4:1 |
| Prompt | 否 | String | 视频内容的描述,中文正向提示词。最多支持200个 utf-8 字符(首尾空格不计入字符数)。 示例值:一只猫在草原上奔跑,写实风格 |
| LogoAdd | 否 | Integer | 为生成视频添加标识的开关,默认为1,0 需前往 控制台 申请开启显示标识自主完成方可生效。 1:添加标识; 0:不添加标识; 其他数值:默认按1处理。 示例值:1 |
| LogoParam | 否 | LogoParam | 默认在生成视频的右下角添加“ AI 生成”字样,如需替换为其他的标识图片,需前往 控制台 申请开启显示标识自主完成。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务ID 示例值:1350360280588853248 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 提交图生视频通用任务
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitImageToVideoGeneralJob
<公共请求参数>
{
"Image": {
"Url": "https://test.cos.ap-guangzhou.myqcloud.com/1-fps15.png"
}
}
输出示例
{
"Response": {
"JobId": "1355169569101660160",
"RequestId": "90eaa0a4-fde3-4df0-a764-8dccaff6bd1c"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。