大模型视频创作引擎查询视频特效任务

1. 接口描述

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

用于查询视频特效任务。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTemplateToVideoJob。
Version	是	String	公共参数，本接口取值：2024-05-23。
Region	是	String	公共参数，详见产品支持的地域列表。
JobId	是	String	任务ID。示例值：1305546906952867840

3. 输出参数

参数名称	类型	描述
Status	String	任务状态。WAIT：等待中，RUN：执行中，FAIL：任务失败，DONE：任务成功示例值：RUN
ErrorCode	String	任务执行错误码。当任务状态不为 FAIL 时，该值为""。示例值：FailedOperation.DriverFailed
ErrorMessage	String	任务执行错误信息。当任务状态不为 FAIL 时，该值为""。示例值：驱动失败
ResultVideoUrl	String	结果视频 URL。有效期 24 小时。示例值：https://console.cloud.tencent.com/result.mp4
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 任务成功完成

任务成功完成，返回结果视频Url

输入示例

POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTemplateToVideoJob
<公共请求参数>

{
    "JobId": "1305546906952867840"
}

输出示例

{
    "Response": {
        "ErrorCode": "",
        "ErrorMessage": "",
        "RequestId": "17288c38-8b83-4ad2-a818-ef2d2d87dfe7",
        "ResultVideoUrl": "https://console.cloud.tencent.com/result.mp4",
        "Status": "DONE"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation.DriverFailed	驱动失败
FailedOperation.ImageBodySmall	输入图身体（头顶到脚踝）高度占比不到图片高度的二分之一
FailedOperation.ImageCheckNoBody	输入图未检测到人体
FailedOperation.ImageDetectFaceFailed	输入图人脸检测失败
FailedOperation.ImageManyPeople	输入图中存在多人
FailedOperation.ImageRadioExcceed	输入图高宽比未在1.2～2.0范围内
FailedOperation.JobNotFound	任务不存在。
FailedOperation.KeyPointUndetected	核心关节点未检测到
FailedOperation.TemplateFirstFrameNotDetectFace	模板视频首帧未检测到人脸
FailedOperation.TemplateNotDetectBody	模板视频存在未检测到人体的帧
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
RequestLimitExceeded	请求的次数超过了频率限制。
RequestLimitExceeded.JobNumExceed	提交任务数超过最大并发。
UnauthorizedOperation	未授权操作。

查询视频特效任务

本页目录：