大模型视频创作引擎查询图片唱演任务-图片唱演相关接口-API 中心-腾讯云

1. 接口描述

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

用于查询图片唱演任务。
支持提交音频和图片生成唱演视频，满足社交娱乐、互动营销等场景的需求。

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

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

3. 输出参数

参数名称	类型	描述
JobId	String	任务ID 示例值：1199999431088685056
StatusCode	String	任务状态码 —RUN：处理中 —FAIL：处理失败 —STOP：处理终止 —DONE：处理完成示例值：["RUN","FAIL","STOP","DONE"]
StatusMsg	String	任务状态信息示例值：["处理中","处理失败","处理中止","处理完成"]
ErrorCode	String	任务执行错误码。当任务状态不为FAIL时，该值为""。示例值：FailedOperation.ModerationFailed
ErrorMessage	String	任务执行错误信息。当任务状态不为FAIL时，该值为""。示例值：审核未通过
ResultVideoUrl	String	生成视频的URL地址。有效期24小时。示例值：https://vcg-prod-xxx.cos.ap-guangzhou.tencentcos.cn/xxx.mp4
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 调用成功-任务完成

任务完成

输入示例

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

{
    "JobId": "1199964964965990400"
}

输出示例

{
    "Response": {
        "JobId": "1199964964965990400",
        "RequestId": "2564192f-1af0-4d1d-ac92-fac0f5844f73",
        "ResultVideoUrl": "https://***.mp4",
        "StatusCode": "DONE",
        "StatusMsg": "处理完成"
    }
}

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. 错误码

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

错误码	描述
FailedOperation.ModerationAudioFailed	音频审核失败
InvalidParameterValue.InvalidAudioDuration	不支持的音频时长。
InvalidParameterValue.InvalidImageAspectRatio	不支持的图片长宽比。
InvalidParameterValue.InvalidImageFormat	不支持的图片格式
InvalidParameterValue.InvalidImageResolution	图片分辨率超限。

查询图片唱演任务

本页目录：