1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
用于提交视频风格化任务。支持将输入视频生成特定风格的视频。生成后的视频画面风格多样、流畅自然,能够满足社交娱乐、互动营销、视频素材制作等场景的需求。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitVideoStylizationJob。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
StyleId | 是 | String | 风格ID。取值说明: 2d_anime:2D动漫; 3d_cartoon:3D卡通; 3d_china:3D国潮; pixel_art:像素风。 示例值:2d_anime, 3d_cartoon, 3d_china, pixel_art |
VideoUrl | 是 | String | 输入视频URL。视频要求: - 视频格式:mp4、mov; - 视频时长:1~60秒; - 视频分辨率:540P~2056P,即长宽像素数均在540px~2056px范围内; - 视频大小:不超过200M; - 视频FPS:15~60fps。 示例值:https://xxx.com/video.mp4 |
StyleStrength | 否 | String | 风格化强度。取值说明: low:风格化强度弱; medium:风格化强度中等; high:风格化强度强。 默认值为medium。 示例值:medium |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务ID。任务有效期为48小时。 示例值:c5daf8f7077d41a69c13aab31a7164f3 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功提交任务
成功提交视频风格化任务
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitVideoStylizationJob
<公共请求参数>
{
"StyleId": "2d_anime",
"VideoUrl": "http://xxxx.mp4",
"StyleStrength": "medium"
}
输出示例
{
"Response": {
"JobId": "c5daf8f7077d41a69c13aab31a7164f3",
"RequestId": "b1990ba2-2d71-419d-8c9d-cab8e33f8352"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DownloadError | 下载视频出错。 |
FailedOperation.VideoDecodeFailed | 视频解码失败。 |
InvalidParameterValue.InvalidVideoAspectRatio | 不支持的视频宽高比。 |
InvalidParameterValue.InvalidVideoDuration | 视频时长超过限制。 |
InvalidParameterValue.InvalidVideoFPS | 不支持的视频FPS。 |
InvalidParameterValue.InvalidVideoFormat | 不支持的视频格式。 |
InvalidParameterValue.InvalidVideoResolution | 不支持的分辨率。 |
InvalidParameterValue.ParameterValueError | 参数字段或者值有误。 |
InvalidParameterValue.StyleNotExist | 风格不存在。 |
InvalidParameterValue.StyleStrengthNotExist | 风格化强度参数不存在。 |
InvalidParameterValue.UrlIllegal | URL格式不合法。 |
InvalidParameterValue.VideoSizeExceed | 视频大小超过限制。 |
RequestLimitExceeded.JobNumExceed | 提交任务数超过最大并发。 |
ResourceUnavailable.NotExist | 计费状态未知。 |