腾讯混元生视频提交视频特效任务

1. 接口描述

接口请求域名： vclm.tencentcloudapi.com 。

提交视频特效任务接口

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SubmitTemplateToVideoJob。
Version	是	String	公共参数，本接口取值：2024-05-23。
Region	是	String	公共参数，详见产品支持的地域列表。
Template	是	String	特效模板名称。请在视频特效模板列表中选择想要生成的特效对应的 template 名称。示例值：hug
Images.N	是	Array of Image	参考图像，不同特效输入图片的数量详见：视频特效模板-图片要求说明 - 支持传入图片Base64编码或图片URL（确保可访问） - 图片格式：支持png、jpg、jpeg、webp、bmp、tiff - 图片文件：大小不能超过10MB（base64后），图片分辨率不小于300300px，不大于40964096，图片宽高比应在1:4 ~ 4:1之间
LogoAdd	否	Integer	为生成视频添加标识的开关，默认为1。传0 需前往控制台申请开启显式标识自主完成后方可生效。 1：添加标识； 0：不添加标识；其他数值：默认按1处理。建议您使用显著标识来提示，该视频是 AI 生成的视频。示例值：1
LogoParam	否	LogoParam	标识内容设置。默认在生成视频的右下角添加“ AI 生成”或“视频由 AI 生成”字样，如需替换为其他的标识图片，需前往控制台申请开启显式标识自主完成。
Resolution	否	String	视频输出分辨率，默认值：360p 。不同特效支持的清晰度及消耗积分数详见：视频特效模板-单次调用消耗积分数列示例值：360p
BGM	否	Boolean	是否为生成的视频添加背景音乐。默认：false，传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加；不传或为 false 则不添加 BGM。示例值：false
ExtraParam	否	ExtraParam	扩展字段。

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: 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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.ImageDecodeFailed	图片解码失败。
FailedOperation.ImageDownloadError	图片下载失败。
FailedOperation.ImageSizeExceed	base64编码后的图片数据过大。
FailedOperation.ModerationFailed	内容审核不通过。
FailedOperation.ModerationResponseError	ModerationFailed
FailedOperation.RequestTimeout	后端服务超时。
InvalidParameter.InvalidParameter	参数不合法。
InvalidParameterValue.UrlIllegal	URL格式不合法。
MissingParameter	缺少参数错误。
RequestLimitExceeded.JobNumExceed	提交任务数超过最大并发。
ResourceUnavailable.NotExist	计费状态未知。
ResourcesSoldOut.ChargeStatusException	账号已欠费。

提交视频特效任务

本页目录：