1. 接口描述
接口请求域名: vclm.tencentcloudapi.com 。
检查图片跳舞输入图
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CheckAnimateImageJob。 |
Version | 是 | String | 公共参数,本接口取值:2024-05-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
TemplateId | 是 | String | 动作模板ID。 示例值:ke3 |
ImageUrl | 否 | String | 图片格式:支持PNG、JPG、JPEG、BMP、WEBP格式; 图片分辨率:长边分辨率范围【192,4096】; 图片大小:不超过10M; 图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 示例值:https://console.cloud.tencent.com/cos/image.png |
ImageBase64 | 否 | String | 图片base64数据。 图片格式:支持PNG、JPG、JPEG、BMP、WEBP格式; 图片分辨率:长边分辨率范围【192,4096】; 图片大小:不超过10M; 图片宽高比:【宽:高】数值在 1:2 到 1:1.2 范围内 示例值:MIIHNjCCBh6gAwIBAgIQCVe4E0h49mzI0NcSqMy1 |
EnableBodyJoins | 否 | Boolean | 是否检测输入图人体12个身体部位(头部、颈部、右肩、右肘、右腕、左肩、左肘、左腕、右髋、左髋,、左膝、右膝)。默认不检测。 示例值:false |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CheckPass | Boolean | 输入图是否通过校验。 示例值:true |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 检测输入图成功案例
检测输入图成功案例
输入示例
POST / HTTP/1.1
Host: vclm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckAnimateImageJob
<公共请求参数>
{
"TemplateId": "ke3",
"ImageUrl": "https://tencent.cos.ap-guangzhou.myqcloud.com/image-animate/user_input/image.png",
"EnableBodyJoins": true
}
输出示例
{
"Response": {
"CheckPass": true,
"RequestId": "96c02249-a683-4c0b-ac1c-50a2dee71695"
}
}
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.BodyJointsFail | 人体关键点检测失败。 |
FailedOperation.FaceSizeTooSmall | 人脸框太小,无法识别使用。 |
FailedOperation.ImageBodyJoinsUndetected | 图片身体部位有遮挡或不全,请重新上传图片 |
FailedOperation.ImageDecodeFailed | 图片解码失败。 |
FailedOperation.ImageFaceDetectFailed | 人脸检测失败 |
FailedOperation.ImageNotSupported | 不支持的图片文件。 |
FailedOperation.ImageRatioExcceed | 图片高宽比超过限制。 |
FailedOperation.ImageResolutionExceed | 图片分辨率过大。 |
FailedOperation.ImageSizeExceed | base64编码后的图片数据过大。 |
FailedOperation.InnerError | 服务内部错误,请重试。 |
FailedOperation.ModerationFailed | 内容审核不通过。 |
InternalError | 内部错误。 |
InvalidParameter.TemplateNotExisted | 模板不存在 |
InvalidParameterValue.InvalidVideoResolution | 不支持的分辨率。 |
InvalidParameterValue.NoFaceInPhoto | 图片中没有人脸。 |
InvalidParameterValue.ParameterValueError | 参数字段或者值有误。 |
LimitExceeded | 超过配额限制。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |