描述

路人消除V2。智能识别并消除图片内的路人，输出干净背景的图像。

接口说明

版本

1.0

请求方式

调用 URL

正式环境：https://openapi.meitu.com
任务提交接口：https://openapi.meitu.com/api/v1/sdk/sync/push
任务名称(task)：`/v1/passerby_remove/494684`
任务类型(task_type)：`formula`

媒体要求

参数名	说明
支持的媒体格式	JPG、JPEG、PNG
支持的媒体大小	≤ 20M

签名验证

开放平台接口签名

调用方法

POST

request 的头的类型应包含：Content-Type:application/json

必传请求头

是否必选	参数名	类型	参数说明
必选	Authorization	String	签名验证信息，详见开放平台接口签名
必选	Content-Type	String	固定为 `application/json`

参数说明

请求参数

是否必选	参数名	类型	参数说明
必选	task	String	任务路径，例如：`/v1/passerby_remove/494684`
必选	task_type	String	任务类型，固定值：`formula`
必选	init_images	Object[]	输入的媒体文件参数
必选	params	String	推理参数（JSON 字符串格式），`{"parameter":{"rsp_media_type":"url"}}` 表示返回 URL 类型媒体
可选	sync_timeout	Int	默认为 -1，表示不等待，接口会立即返回结果并使用异步任务处理。请使用任务查询接口。

init_images 媒体文件参数说明

init_images 为数组类型，每个元素表示一个媒体资源（如图片等）。

是否必选	参数名	类型	参数说明
必选	url	String	媒体文件访问地址
可选	profile	Object	多媒体参数配置

profile 参数说明

是否必选	参数名	类型	参数说明
必选	media_profiles	object	媒体文件的相关属性信息描述

media_profiles 中参数说明

是否必选	参数名	类型	参数说明
否	media_data_type	String	默认 "url" 表示 media_data 是 url 地址

params 为 JSON 字符串，解析后的结构如下：

{
  "parameter": {
    "rsp_media_type": "url"
  }
}

parameter 参数说明

是否必填	参数名	类型	参数说明
否	rsp_media_type	String	返回结果媒体类型：`jpg` 表示结果图像以 Base64 编码格式返回；`url` 表示结果图像以 URL 地址格式返回

请求值示例

{
  "task": "/v1/passerby_remove/494684",
  "task_type": "formula",
  "init_images": [
    {
      "url": "https://mv-openplatform.meitudata.com/product_img/6a8eaec9e1b8b1ks1t77rb9895.jpg",
      "profile": {
        "media_profiles": {
          "media_data_type": "url"
        }
      }
    }
  ],
  "params": "",
  "sync_timeout": -1
}

成功返回值说明

字段	类型	参数说明
request_id	String	请求 ID
trace_id	String	链路追踪 ID
code	Number	HTTP 层状态码，`0` 表示成功
error_code	Number	业务错误码，`0` 表示成功，详见 API 错误码
message	String	返回信息，成功时为 `success`
data	Object	返回的业务数据

data 字段说明

字段	类型	参数说明
status	Number	任务状态，`10` 表示任务已完成
result	Object	任务处理结果
progress	Number	任务进度，取值范围 0～1，`1` 表示完成
predict_elapsed	Number	预测处理耗时，单位：毫秒
create_time	Number	任务创建时间戳，单位：毫秒
task_id	String	任务 ID
custom_task_id	String	自定义任务 ID
trace_id	String	跟踪 ID
client_info	String	客户端信息
init_images	Array	初始输入媒体信息
instance_id	String	实例 ID

result 字段说明

字段	类型	参数说明
id	String	任务唯一标识
urls	Array	生成的图像 URL 列表
parameters	Object	算法参数信息，包含任务处理详情
images	Array	生成的图像 URL 列表
media_info_list	Array	媒体信息列表

result.parameters 字段说明

字段	类型	参数说明
category	String	算法类别
formula_id	String	配方 ID
rsp_media_type	String	响应媒体类型
task_id	String	任务 ID
trace_id	String	链路追踪 ID

media_info_list 字段说明

字段	类型	参数说明
media_data	String	媒体数据 URL
media_extra	Object	媒体附加信息
media_profiles	Object	媒体配置信息

media_profiles 字段说明

字段	类型	参数说明
media_data_type	String	媒体数据类型，如 `"url"`
media_data_height	Number	媒体高度（像素）
media_data_width	Number	媒体宽度（像素）
media_data_size	Number	媒体大小（字节）

请求成功返回示例

{
  "request_id": "",
  "trace_id": "",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "data": {
    "status": 9,
    "result": {
      "id": "t_mt1a3i5n7b7320bde7-9f69-4722-aa1a-bec2a333dc38"
    },
    "progress": 0,
    "predict_elapsed": 10000,
    "create_time": 1787737214318,
    "task_id": "t_mt1a3i5n7b7320bde7-9f69-4722-aa1a-bec2a333dc38",
    "custom_task_id": "",
    "trace_id": "381aa78b-52c0-4f45-b199-304c212209e0",
    "client_info": "",
    "init_images": null,
    "instance_id": "7498313349026305833"
  }
}

通过任务id异步请求成功返回示例

请使用任务查询接口异步查询。

{
  "request_id": "",
  "trace_id": "",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "data": {
    "status": 10,
    "result": {
      "id": "t_mt1a3i5n7b7320bde7-9f69-4722-aa1a-bec2a333dc38",
      "urls": [
        "https://oss-open-platform.meitudata.com/mtopen/ff56d688358849259556be0f50065a60/c46d3317-8385-4b2d-6336-b8ae26776709.jpeg"
      ],
      "parameters": {},
      "images": [
        "https://oss-open-platform.meitudata.com/mtopen/ff56d688358849259556be0f50065a60/c46d3317-8385-4b2d-6336-b8ae26776709.jpeg"
      ],
      "media_info_list": [
        {
          "media_data": "https://oss-open-platform.meitudata.com/mtopen/ff56d688358849259556be0f50065a60/c46d3317-8385-4b2d-6336-b8ae26776709.jpeg",
          "media_extra": null,
          "media_profiles": {
            "media_data_height": 1512,
            "media_data_size": 1481480,
            "media_data_type": "url",
            "media_data_width": 1280
          }
        }
      ]
    },
    "progress": 1,
    "predict_elapsed": 10000,
    "create_time": 1787737214318,
    "task_id": "t_mt1a3i5n7b7320bde7-9f69-4722-aa1a-bec2a333dc38",
    "custom_task_id": "",
    "trace_id": "",
    "client_info": "",
    "init_images": null
  }
}

失败返回值说明

字段	类型	说明
data	String	返回的内容
message	String	错误信息
error_code	Number	错误代码

请求失败返回示例

Response Status：400
content-type 为 application/json; charset=utf-8

{
  "error_code": 20001,
  "message": "PROCESS_ERROR",
  "data": null
}

当前 API 特有的错误代码与信息

ErrorCode 状态代码	错误信息	说明
20001	PROCESS_ERROR	处理错误

通用的错误代码与信息

详见 API 错误码

调用示例

curl 示例

curl --request POST \
  --url 'https://openapi.meitu.com/api/v1/sdk/sync/push' \
  --header 'Authorization: Bearer YourSignAuthCode' \
  --header 'Content-Type: application/json' \
  --data '{
    "task": "/v1/passerby_remove/494684",
    "task_type": "formula",
    "init_images": [
      {
        "url": "https://mv-openplatform.meitudata.com/product_img/6a8eaec9e1b8b1ks1t77rb9895.jpg",
        "profile": {
          "media_profiles": {
            "media_data_type": "url"
          }
        }
      }
    ],
    "params": "",
    "sync_timeout": -1
  }'