1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
用于提交图片跳舞任务。图片跳舞能力支持舞蹈动作结合图片生成跳舞视频,满足社交娱乐、互动营销等场景的需求。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SubmitImageAnimateJob。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ImageUrl | 否 | String | 图片格式:支持PNG、JPG、JPEG格式; 图片分辨率:长边分辨率不超过2056; 图片大小:不超过10M; 图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 示例值:https://xxx/1.png |
ImageBase64 | 否 | String | 图片base64数据。图片格式:支持PNG、JPG、JPEG格式;图片分辨率:长边分辨率不超过2056;图片大小:不超过10M;图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 示例值:MIIHNjCCBh6gAwIBAgIQCVe4E0h49mzI0NcSqMy1+jANBgkqhkiG9w0BAQsFADB1 MQswCQYDVQQGEwJVUzEVMBMG |
TemplateId | 否 | String | 动作模板ID。取值说明:ke3 科目三;tuziwu 兔子舞;huajiangwu 划桨舞。 示例值:ke3 |
EnableAudio | 否 | Boolean | 结果视频是否保留模板音频。默认为true 示例值:true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
JobId | String | 任务ID。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用成功示例
调用成功示例
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SubmitImageAnimateJob
<公共请求参数>
{
"ImageUrl": "https://xxx/image-animate/user_input/1.png",
"TemplateId": "ke3",
"EnableAudio": true
}
输出示例
{
"Response": {
"JobId": "1194931538865782784",
"RequestId": "4e6722ba-367b-454e-add0-681a5c50fe20"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.FaceSizeTooSmall | 人脸框太小,无法识别使用。 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageNotSupported | 不支持的图片文件。 |
FailedOperation.ImageResolutionExceed | 图片分辨率过大。 |
FailedOperation.ImageSizeExceed | base64编码后的图片数据过大。 |
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.JobQueueFull | 任务队列已满,请稍后重试。 |
FailedOperation.ModerationFailed | 内容审核不通过。 |
InvalidParameterValue.InvalidVideoResolution | 不支持的分辨率。 |
InvalidParameterValue.NoFaceInPhoto | 图片中没有人脸。 |
InvalidParameterValue.ParameterValueError | 参数字段或者值有误。 |
LimitExceeded | 超过配额限制。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded.JobNumExceed | 提交任务数超过最大并发。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |