1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
提交视频特效任务接口
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitTemplateToVideoJob。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Template | 是 | String | 特效模板名称。 枚举值: hug :拥抱 kiss :亲吻 heart : 比心 fuzzy : 毛茸茸 befigure:变手办风 longhair:金色长发 morphlab:膨胀 bloom:万物生花 pinch:捏捏 balloonfly:飞走了 dragme:被拽走了 示例值:hug |
Images.N | 是 | Array of Image | 参考图像,最多输入2张图。 - 支持传入图片Base64编码或图片URL(确保可访问) - 图片格式:支持png、jpg、jpeg、webp、bmp、tiff - 图片文件:大小不能超过10MB(base64后),图片分辨率不小于300*300px,不大于4096*4096,图片宽高比应在1:4 ~ 4:1之间 |
LogoAdd | 否 | Integer | 为生成视频添加标识的开关,默认为1。 1:添加标识。 0:不添加标识。 其他数值:默认按1处理。 建议您使用显著标识来提示,该视频是 AI 生成的视频。 示例值:1 |
LogoParam | 否 | LogoParam | 标识内容设置。 默认在生成视频的右下角添加“视频由 AI 生成”字样,您可根据自身需要替换为其他的标识图片。 |
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: SubmitTemplateToVideoJob
<公共请求参数>
{
"Template": "hug",
"Images": [
{
"Url": "https://test.jpg"
}
]
}
输出示例
{
"Response": {
"JobId": "1305518294765740032",
"RequestId": "2392f73f-6436-4f79-85dc-6283d2ca78ef"
}
}
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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。