1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
用于提交视频编辑任务,支持上传视频、文本及图片素材开展编辑操作,涵盖风格迁移、元素替换、内容增减等核心能力。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SubmitVideoEditJob。 |
| Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| VideoUrl | 是 | String | 参考视频URL。默认为待编辑视频。 - 视频格式:支持MP4 - 视频时长:输入视频时长≤5秒 - 视频大小:不超过200M - 视频文件:输入的视频帧率及分辨率不做限制(建议输入16:9或9:16的视频;分辨率建议在2160px内,帧率建议在60fps内);输出视频是帧率会≥16fps,分辨率为720p 示例值:https://cos.ap-guangzhou.myqcloud.com/video.mp4 |
| Prompt | 否 | String | 视频内容的描述,中文正向提示词。支持视频内容增加、删除、修改等能力 - 最多支持200个 utf-8 字符(首尾空格不计入字符数) - 不传prompt的时候,Images.N参考图列表必须要传图,且传的图片是经过图片编辑之后的结果图 示例值:将视频中男性左手上的篮球删除,保持其他内容不变 |
| Images.N | 否 | Array of Image | 参考图列表。用于对视频内容做风格迁移、内容替换、内容删减、内容增加做参考。 - 支持传入图片Base64编码或图片URL - 图片格式:支持jpg,png,jpeg,webp,bmp,tiff 格式 - 图片文件:大小不能超过10MB(base64后)。单边分辨率不超过5000px,不小于50px,图片长宽限制1:4 ~ 4:1。 示例值:[{ "Url": "https://console.cloud.tencent.com/cos/image.png"}] |
| LogoAdd | 否 | Integer | 为生成视频添加标识的开关,默认为1。传0 需前往 控制台 申请开启显式标识自主完成后方可生效。 1:添加标识; 0:不添加标识; 其他数值:默认按1处理。 建议您使用显著标识来提示,该视频是 AI 生成的视频。 示例值:1 |
| LogoParam | 否 | LogoParam | 标识内容设置。 默认在生成视频的右下角添加“ AI 生成”或“视频由 AI 生成”字样,如需替换为其他的标识图片,需前往 控制台 申请开启显式标识自主完成。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 任务ID。 示例值:1390601287988002816 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用示例
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitVideoEditJob
<公共请求参数>
{
"VideoUrl": "https://cos.ap-guangzhou.myqcloud.com/xxx.mp4",
"Prompt": "Edit the object in the video",
"Image": {
"Url": "https://cos.ap-guangzhou.myqcloud.com/xxx.png"
}
}
输出示例
{
"Response": {
"JobId": "1390601287988002816",
"RequestId": "33de6b6d-99cd-498c-a3b2-f31db1e94ab8"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。