1. 接口描述
接口请求域名： bda.tencentcloudapi.com 。
检测图片中人体的14个关键点。建议用于人体图像清晰、无遮挡的场景。支持一张图片中存在多个人体的识别。
默认接口请求频率限制：300次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DetectBodyJoints。 |
| Version | 是 | String | 公共参数，本接口取值：2020-03-24。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。 |
| Image | 否 | String | 图片 base64 数据，base64 编码后大小不可超过5M。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。 |
| Url | 否 | String | 图片的 Url 。对应图片 base64 编码后大小不可超过5M。 Url、Image必须提供一个，如果都提供，只使用 Url。 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。 非腾讯云存储的Url速度和稳定性可能受一定影响。 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。 示例值：IamNotUrl |
| LocalBodySwitch | 否 | Boolean | 人体局部关键点识别，开启后对人体局部图（例如部分身体部位）进行关键点识别，输出人体关键点坐标，默认不开启 注意：若开启人体局部图片关键点识别，则BoundBox、Confidence返回为空。 示例值：true |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BodyJointsResults | Array of BodyJointsResult | 图中检测出的人体框和人体关键点， 包含14个人体关键点的坐标，建议根据人体框置信度筛选出合格的人体； |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用失败示例
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectBodyJoints
<公共请求参数>
{
"Url": "IamNotUrl"
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.UrlIllegal",
"Message": "URL格式不合法。"
},
"RequestId": "b5f77c78-efaf-42d1-b0ac-419cc70b4994"
}
}示例2 调用成功示例
输入示例
POST / HTTP/1.1
Host: bda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DetectBodyJoints
<公共请求参数>
{
"Url": "test.jpg"
}输出示例
{
"Response": {
"BodyJointsResults": [
{
"BoundBox": {
"X": 134,
"Y": 169,
"Width": 270,
"Height": 486
},
"BodyJoints": [
{
"X": 233.458984375,
"Y": 212.494140625,
"KeyPointType": "头部"
},
{
"X": 237.619140625,
"Y": 249.935546875,
"KeyPointType": "颈部"
},
{
"X": 283.380859375,
"Y": 266.576171875,
"KeyPointType": "右肩"
},
{
"X": 324.982421875,
"Y": 308.177734375,
"KeyPointType": "右肘"
},
{
"X": 295.861328125,
"Y": 349.779296875,
"KeyPointType": "右腕"
},
{
"X": 208.498046875,
"Y": 274.896484375,
"KeyPointType": "左肩"
},
{
"X": 183.537109375,
"Y": 337.298828125,
"KeyPointType": "左肘"
},
{
"X": 158.576171875,
"Y": 387.220703125,
"KeyPointType": "左腕"
},
{
"X": 262.580078125,
"Y": 395.541015625,
"KeyPointType": "右髋"
},
{
"X": 237.619140625,
"Y": 466.263671875,
"KeyPointType": "右膝"
},
{
"X": 216.818359375,
"Y": 557.787109375,
"KeyPointType": "右踝"
},
{
"X": 254.259765625,
"Y": 399.701171875,
"KeyPointType": "左髋"
},
{
"X": 266.740234375,
"Y": 482.904296875,
"KeyPointType": "左膝"
},
{
"X": 349.943359375,
"Y": 545.306640625,
"KeyPointType": "左踝"
}
],
"Confidence": 0.99999010562897
}
],
"RequestId": "97d85578-6b11-4e7c-beea-65601bc0bc04"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.BodyFeatureFail | 人体特征检测失败。 |
| FailedOperation.BodyJointsFail | 人体关键点检测失败。 |
| FailedOperation.DownloadError | 文件下载失败。 |
| FailedOperation.ImageDecodeFailed | 图片解码失败。 |
| FailedOperation.ImageDownloadError | 图片下载错误。 |
| FailedOperation.ImageResolutionExceed | 图片分辨率过大。 |
| FailedOperation.ImageSizeExceed | base64编码后的图片数据过大。 |
| FailedOperation.InnerError | 服务内部错误，请重试。 |
| FailedOperation.NoBodyInPhoto | 图片中没有人体。 |
| FailedOperation.RequestEntityTooLarge | 整个请求体太大（通常主要是图片）。 |
| FailedOperation.RequestTimeout | 后端服务超时。 |
| FailedOperation.RpcFail | RPC请求失败，一般为算法微服务故障。 |
| FailedOperation.UnKnowError | 内部错误。 |
| FailedOperation.Unknown | 未知错误。 |
| InvalidParameter.InvalidParameter | 参数不合法。 |
| InvalidParameterValue.ImageEmpty | 图片为空。 |
| InvalidParameterValue.UrlIllegal | URL格式不合法。 |
| LimitExceeded.TooLargeFileError | 文件太大。 |
| ResourceUnavailable.InArrears | 账号已欠费。 |
| ResourceUnavailable.NotExist | 计费状态未知，请确认是否已在控制台开通服务。 |
| UnsupportedOperation.UnknowMethod | 未知方法名。 |
