肢体关键点检测
描述
本接口用于云端处理肢体检测的请求,返回图片中人像的肢体关键点检测信息。
版本
1.0
图片要求
图片格式:JPG、PNG。
调用 URL
正式环境:https://openapi.meitu.com
任务提交接口:https://openapi.meitu.com/api/v1/sdk/sync/push
任务名称(task):/v1/Body_Keypoint_Detection/487158
任务类型(task_type):formula调用方法
POST
Content-Type: application/json
权限
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | params | string | 算法参数(JSON 字符串) |
| 必选 | init_images | object[] | 多媒体文件列表 |
| 必选 | task | string | 固定 /v1/Body_Keypoint_Detection/487158 |
| 必选 | task_type | string | 固定 formula |
| 可选 | sync_timeout | int | 默认 30,同步超时时间 |
init_images 多媒体文件参数,结构说明如下
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | url | string | 图片 URL 或 base64 |
| 必选 | profile | object | 属性信息描述 |
profile 属性信息描述
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | media_profiles | object | 媒体属性信息 |
| 必选 | version | string | 固定 v1 |
media_profiles 媒体属性信息
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | media_data_type | string | url 表示 URL;jpg 等类型表示 base64 |
params 推理参数是 JSON 字符串,其结构说明如下
| 是否必选 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 可选 | rsp_media_type | string | 默认 url;jpg 表示结果图像以 Base64 编码格式返回,url 表示以 URL 地址格式返回 |
| 必选 | parameter | object | 算法核心参数对象 |
parameter 算法参数详情
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 可选 | version | string | 算法版本,默认 1.0.0 |
输入值示例
{
"task": "/v1/Body_Keypoint_Detection/487158",
"task_type": "formula",
"init_images": [
{
"url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTcwOTE4MjgwMA==/58fdb25d-8e6f-4026-4a5e-45d9894190a4.png",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"version\":\"1.0.0\"}}",
"sync_timeout": 30
}返回值说明
注意,生成的结果,会定期清理,请及时下载保存| 字段 | 类型 | 说明 |
|---|---|---|
| request_id | string | 请求标识 |
| trace_id | string | 链路追踪标识 |
| code | int | 业务状态码,0 表示请求受理成功 |
| error_code | int | 错误码,成功时为 0 |
| message | string | 业务信息 |
| tips | any | 补充提示,可为 null |
| data | object | 任务状态和算法结果 |
data 中单个元素的字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| status | int | 状态码:-1 未找到任务;0 创建成功;1 执行中;2 失败;9 超时,使用查询接口查询;10 成功 |
| result | object | 算法结果 |
| progress | number | 任务进度 |
| predict_elapsed | int | 预计耗时,毫秒 |
| create_time | int64 | 创建时间戳,毫秒 |
| task_id | string | 任务 ID |
| custom_task_id | string | 客户自定义任务 ID |
| trace_id | string | 链路追踪标识 |
| client_info | string | 客户端信息 |
| init_images | object[]/null | 输入媒体回显 |
result 中单个元素的字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 任务唯一标识 |
| urls | string[] | 结果资源 URL 列表 |
| images | string[] | 返回的图片资源 |
| parameters | object | 算法参数信息,包含字符串类型的 version |
| data | object | 算法原始返回数据 |
| mtlab_res | object | MTLab 原始返回结果 |
| media_info_list | object[] | 媒体结果信息列表 |
result.data、result.mtlab_res 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| ErrorCode | int | 算法错误码,0 表示成功 |
| ErrorMsg | string | 算法错误信息 |
| error_code | int | 同 ErrorCode |
| error_msg | string | 同 ErrorMsg |
| media_info_list | object[] | 媒体结果信息列表 |
| msg_id | string | 消息 ID |
| parameter | object | 算法参数,包含字符串类型的 version |
media_info_list 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| media_data | string | 媒体数据,如图片 URL 或 Base64 |
| media_extra | object | 算法附加结果 |
| media_profiles | object/null | 媒体配置参数 |
media_extra 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| body_pose | array | 肢体检测信息,包含图片中 N 个人像的肢体关键点信息;每个人像包含 14 个点,每个点为 [x, y, score];关键点顺序见肢体关键点序号说明 |
body_pose 中每个关键点字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| x | float | 关键点横坐标,以图片左上角为 (0, 0),示例值范围为 0~1 |
| y | float | 关键点纵坐标,以图片左上角为 (0, 0),示例值范围为 0~1 |
| score | float | 关键点置信度,范围为 [0, 1],值越高代表预测点的可信度越高 |
每个三元组表示一个关键点;[0, 0, 0] 表示该关键点未检测到;数组顺序与算法定义的关键点顺序一致。
当前 API 特有的错误代码与信息
| ErrorCode 状态代码 | 错误信息 | 说明 |
|---|---|---|
| 20001 | PROCESS_ERROR | 处理错误 |
返回值示例
请求成功返回示例
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 10,
"result": {
"id": "t_mt1a3i5n7bfb3cb4d5-xxxx-416c-aca2-4ea85e2392d0",
"urls": [""],
"images": [""],
"parameters": {
"version": "1.0.0"
},
"data": {
"ErrorCode": 0,
"ErrorMsg": "",
"error_code": 0,
"error_msg": "",
"media_info_list": [
{
"media_data": "",
"media_extra": {
"body_pose": [
[
[0.382604, 0.237499, 0.960717],
[0.397724, 0.353015, 0.89843],
[0.313316, 0.413948, 0.875583],
[0.5135, 0.376142, 0.862831],
[0.31644, 0.526003, 0.829664],
[0.600144, 0.489705, 0.841293],
[0.480908, 0.576402, 0.791474],
[0.602069, 0.600498, 0.751575],
[0.415567, 0.600929, 0.638177],
[0.550402, 0.588666, 0.609929],
[0.31724, 0.587703, 0.800953],
[0.617525, 0.65204, 0.0674782],
[0.433666, 0.826302, 0.819607],
[0, 0, 0]
]
]
},
"media_profiles": null
}
],
"msg_id": "",
"parameter": {
"version": "1.0.0"
}
},
"mtlab_res": {
"ErrorCode": 0,
"ErrorMsg": "",
"error_code": 0,
"error_msg": "",
"media_info_list": [
{
"media_data": "",
"media_extra": {
"body_pose": [
[
[0.382604, 0.237499, 0.960717],
[0.397724, 0.353015, 0.89843],
[0.313316, 0.413948, 0.875583],
[0.5135, 0.376142, 0.862831],
[0.31644, 0.526003, 0.829664],
[0.600144, 0.489705, 0.841293],
[0.480908, 0.576402, 0.791474],
[0.602069, 0.600498, 0.751575],
[0.415567, 0.600929, 0.638177],
[0.550402, 0.588666, 0.609929],
[0.31724, 0.587703, 0.800953],
[0.617525, 0.65204, 0.0674782],
[0.433666, 0.826302, 0.819607],
[0, 0, 0]
]
]
},
"media_profiles": null
}
],
"msg_id": "",
"parameter": {
"version": "1.0.0"
}
},
"media_info_list": [
{
"media_data": "",
"media_extra": {
"body_pose": [
[
[0.382604, 0.237499, 0.960717],
[0.397724, 0.353015, 0.89843],
[0.313316, 0.413948, 0.875583],
[0.5135, 0.376142, 0.862831],
[0.31644, 0.526003, 0.829664],
[0.600144, 0.489705, 0.841293],
[0.480908, 0.576402, 0.791474],
[0.602069, 0.600498, 0.751575],
[0.415567, 0.600929, 0.638177],
[0.550402, 0.588666, 0.609929],
[0.31724, 0.587703, 0.800953],
[0.617525, 0.65204, 0.0674782],
[0.433666, 0.826302, 0.819607],
[0, 0, 0]
]
]
},
"media_profiles": null
}
]
},
"progress": 0,
"predict_elapsed": 10000,
"create_time": 1770357763826,
"task_id": "t_mt1a3i5n7bfb3cb4d5-xxxx-416c-aca2-4ea85e2392d0",
"custom_task_id": "",
"trace_id": "",
"client_info": "",
"init_images": null
}
}需要查询返回示例
使用 查询接口 接口查询
Response Status:200
content-type 为 application/json; charset=utf-8
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 9,
"result": {
"id": "t_mt1a3i5n7b7a7ba41b-xxxx-4cdb-a0be-1fd951bd1ffc"
},
"progress": 0,
"predict_elapsed": 10000,
"create_time": 1770283596272,
"task_id": "t_mt1a3i5n7b7a7ba41b-xxxx-4cdb-a0be-1fd951bd1ffc",
"custom_task_id": "",
"trace_id": "1e106f37-xxxx-4f2c-8bb2-f480ebae4dda",
"client_info": "",
"init_images": null
}
}请求失败返回示例
Response Status:400
content-type 为 application/json; charset=utf-8
{
"request_id": "",
"trace_id": "",
"code": 20001,
"error_code": 20001,
"message": "PROCESS_ERROR",
"tips": null,
"data": {
"status": 2,
"result": {
"ErrorCode": 20001,
"ErrorMsg": "PROCESS_ERROR"
},
"progress": 0,
"predict_elapsed": 0,
"create_time": 0,
"task_id": "",
"custom_task_id": "",
"trace_id": "",
"client_info": "",
"init_images": null
}
}通用的错误代码与信息
详见 API 错误码
SDK 调用示例
Python
import json
import requests
from sign_sdk import sign
def api_call_example():
key = "your_api_key"
secret = "your_api_secret"
url = "https://openapi.meitu.com/api/v1/sdk/sync/push"
method = "POST"
headers = {
"Content-Type": "application/json",
sign.HeaderHost: "openapi.meitu.com",
}
inner_params = {
"rsp_media_type": "url",
"parameter": {"version": "1.0.0"},
}
payload = {
"task": "/v1/Body_Keypoint_Detection/487158",
"task_type": "formula",
"init_images": [
{
"url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTcwOTE4MjgwMA==/58fdb25d-8e6f-4026-4a5e-45d9894190a4.png",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1",
},
}
],
"params": json.dumps(inner_params, ensure_ascii=False),
"sync_timeout": 30,
}
body = json.dumps(payload, ensure_ascii=False)
signer = sign.Signer(key, secret)
signed_request = signer.sign(url, method, headers, body)
response = requests.Session().send(signed_request)
print(f"Status: {response.status_code}")
print(f"Response: {response.text}")
if __name__ == "__main__":
api_call_example()Go
package main
import (
"fmt"
"io"
"net/http"
"github.com/mtlab/api/signer"
)
func main() {
key := "your_api_key"
secret := "your_api_secret"
signObj := signer.NewSigner(key, secret)
url := "https://openapi.meitu.com/api/v1/sdk/sync/push"
method := http.MethodPost
headers := make(http.Header)
headers.Set(signer.HeaderHost, "openapi.meitu.com")
headers.Set("Content-Type", "application/json")
body := `{
"task": "/v1/Body_Keypoint_Detection/487158",
"task_type": "formula",
"init_images": [{
"url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTcwOTE4MjgwMA==/58fdb25d-8e6f-4026-4a5e-45d9894190a4.png",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1"
}
}],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"version\":\"1.0.0\"}}",
"sync_timeout": 30
}`
req, err := signObj.Sign(url, method, headers, body)
if err != nil {
fmt.Println("Failed to sign request:", err)
return
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("Failed to send request:", err)
return
}
defer resp.Body.Close()
responseBody, err := io.ReadAll(resp.Body)
if err != nil {
fmt.Println("Read response failed:", err)
return
}
fmt.Println("Response:", resp.StatusCode, string(responseBody))
}PHP
<?php
require 'signer.php';
$key = 'your_api_key';
$secret = 'your_api_secret';
$signer = new Signer($key, $secret);
$url = 'https://openapi.meitu.com/api/v1/sdk/sync/push';
$method = 'POST';
$headers = ['Content-Type' => 'application/json'];
$innerParams = json_encode([
'rsp_media_type' => 'url',
'parameter' => ['version' => '1.0.0'],
]);
$body = json_encode([
'task' => '/v1/Body_Keypoint_Detection/487158',
'task_type' => 'formula',
'init_images' => [
[
'url' => 'https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTcwOTE4MjgwMA==/58fdb25d-8e6f-4026-4a5e-45d9894190a4.png',
'profile' => [
'media_profiles' => ['media_data_type' => 'url'],
'version' => 'v1',
],
],
],
'params' => $innerParams,
'sync_timeout' => 30,
]);
$curl = $signer->sign($url, $method, $headers, $body);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($status === 0) {
echo 'Error: ' . curl_error($curl);
} else {
echo "Status: {$status}\n";
echo "Response: {$response}\n";
}
curl_close($curl);
?>Java
package com.meitu.openai.common;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
public class Main {
public static void main(String[] args) throws Exception {
Signer signer = new Signer("your_api_key", "your_api_secret");
String url = "https://openapi.meitu.com/api/v1/sdk/sync/push";
String method = "POST";
Map<String, String> headers = new HashMap<>();
headers.put("Content-Type", "application/json");
headers.put(Signer.HeaderHost, "openapi.meitu.com");
String body = "{\n" +
" \"task\": \"/v1/Body_Keypoint_Detection/487158\",\n" +
" \"task_type\": \"formula\",\n" +
" \"init_images\": [{\n" +
" \"url\": \"https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTcwOTE4MjgwMA==/58fdb25d-8e6f-4026-4a5e-45d9894190a4.png\",\n" +
" \"profile\": {\n" +
" \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
" \"version\": \"v1\"\n" +
" }\n" +
" }],\n" +
" \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"version\\\":\\\"1.0.0\\\"}}\",\n" +
" \"sync_timeout\": 30\n" +
"}";
Map<String, String> signedHeaders = signer.sign(url, method, headers, body);
HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
connection.setRequestMethod(method);
for (Map.Entry<String, String> entry : signedHeaders.entrySet()) {
connection.setRequestProperty(entry.getKey(), entry.getValue());
}
connection.setDoOutput(true);
connection.getOutputStream().write(body.getBytes(StandardCharsets.UTF_8));
int status = connection.getResponseCode();
InputStream stream = status >= 400
? connection.getErrorStream()
: connection.getInputStream();
try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream))) {
StringBuilder response = new StringBuilder();
String line;
while ((line = reader.readLine()) != null) {
response.append(line);
}
System.out.println("Response: " + status + " " + response);
}
}
}