路人消除
描述
本接口用于云端处理路人消除的请求,通过 AI 算法自动识别并消除图片中的路人,还原干净的背景画面。
版本
1.0
图片要求
图片格式:JPG、PNG
调用 URL
正式环境:https://openapi.meitu.com
任务提交接口:https://openapi.meitu.com/api/v1/sdk/sync/push
任务名称(task):/v1/Passersby_Elimination/453194
任务类型(task_type):formula调用方法
POST
Content-Type: application/json
权限
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | params | string | 算法参数(JSON 字符串) |
| 必选 | init_images | object[] | 多媒体文件列表 |
| 必选 | task | string | 固定 /v1/Passersby_Elimination/453194 |
| 必选 | task_type | string | 固定 formula |
| 可选 | sync_timeout | int | 默认 30,同步超时时间;-1 表示不等待;接口超时后 status 返回 9,使用查询接口查询 |
init_images 多媒体文件参数,结构说明如下
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | url | string | 多媒体 URL 或 base64 |
| 必选 | profile | object | 属性信息描述 |
profile 属性信息描述
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | media_profiles | object | 媒体属性信息 |
| 可选 | media_extra | object | 多媒体附加参数 |
| 必选 | version | string | 固定 v1 |
media_profiles 媒体属性信息
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | media_data_type | string | url 表示 URL;jpg 表示 base64 |
params 推理参数是 JSON 字符串,其结构说明如下
| 是否必选 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 可选 | rsp_media_type | string | 默认 url;jpg 表示 base64 |
| 必选 | parameter | object | 算法核心参数对象 |
parameter 算法参数详情
| 是否必选 | 参数名 | 类型 | 说明 |
|---|---|---|---|
| 可选 | expand_params | string | AI 消除参数,JSON 字符串,内含 parameter 对象;默认值 {"parameter":{"generate_num":1}} |
| 可选 | result_type | string | 0:只返回结果图;1:返回 mask 图和结果图;默认值为 0 |
expand_params 解码后的 parameter 算法参数详情
| 是否必选 | 参数名 | 类型 | 说明 |
|---|---|---|---|
| 可选 | generate_num | int | 返回图像数量,默认为 4 |
| 可选 | seed | int | 随机种子 [-1, 65535];-1 表示随机种子(每次返回不同效果);不传时默认为 0(种子固定时每次返回效果相同,推荐调用方在外部自行随机后填入,方便复现 badcase) |
| 可选 | scheduler | string | 采样器类型,可选:DDIM / DEIS-M / KDPM-2D / KDPM-2AD / Euler-AD / Euler-D / Heun-D / LMS-D / DPM-SM / PNDM / DPM-SS / UniPC-M,默认为 DDIM |
| 可选 | step | int | 采样步数,默认为 25,取值范围 1-1000 |
| 可选 | expand_ratio | float | 旧版消除算法黑边框规避参数,设置为 0 可避免黑边(版本号 1.0.33 及以下使用,后续版本无需设置),取值范围不能为负 |
| 可选 | auto_adjust_mask_edge | bool | 是否对输入 mask 进行自适应边缘调整后再执行消除(mask 由分割算法得到或主体周围有明显阴影时推荐开启),默认为 true |
| 可选 | return_modified_mask | bool | 是否返回实际执行消除时所用的 mask 图(开启后接口同时返回 rgb 结果图和单通道 mask 图,共 generate_num×2 张,mask 图的 media_profiles 中会增加 is_mask=True 标志位),默认为 false |
| 可选 | high_quality_encode | bool | 是否使用高质量低压缩率方式编码结果图像(图像内容不变,质量更好,但接口耗时增加),默认为 false |
输入值示例
{
"task": "/v1/Passersby_Elimination/453194",
"task_type": "formula",
"init_images": [
{
"url": "https://example.com/input.jpg",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"expand_params\":\"{\\\"parameter\\\":{\\\"step\\\":25,\\\"generate_num\\\":1,\\\"seed\\\":-1}}\",\"result_type\":\"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 | data 内链路标识 |
| client_info | string | 客户端信息 |
| init_images | object[]/null | 输入媒体回显 |
result 中单个元素的字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 任务 ID |
| urls | string[] | 结果图片地址列表;当 result_type=1 时,同时返回结果图与 mask 图,共 generate_num×2 张 |
返回值示例
请求成功返回示例
Response Status:200
content-type 为 application/json; charset=utf-8
{
"request_id": "req_abc123",
"trace_id": "trace_abc123",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 10,
"result": {
"id": "t_mt1a3i5n7b7e45698e-7212-4bae-ac7e-9766498c71a5",
"urls": [
"https://obs-large.mtlab.meitu.com/mtopen/23e48d1b186e4d75b5769628d98e0496/MTcxODE3MjAwMA==/d4772377-35b3-474b-53b9-674f992d53b0.jpeg"
]
},
"progress": 1,
"predict_elapsed": 3500,
"create_time": 1759202368761,
"task_id": "t_mt1a3i5n7b7e45698e-7212-4bae-ac7e-9766498c71a5",
"custom_task_id": "",
"trace_id": "9129a3a2-99c4-46ce-8731-0e100e2fbee7",
"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_mt1a3i5n7b3da6d589-46b5-4f66-a0bb-8dd22f2a172e"
},
"progress": 0,
"predict_elapsed": 10000,
"create_time": 1759202368761,
"task_id": "t_mt1a3i5n7b3da6d589-46b5-4f66-a0bb-8dd22f2a172e",
"custom_task_id": "",
"trace_id": "9129a3a2-99c4-46ce-8731-0e100e2fbee7",
"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": "ALGO_MODEL_CRASH",
"tips": null,
"data": {
"status": 2,
"result": {
"id": "t_mt1a3i5n7be8d575cc-2ffb-4e0c-85a8-1824110e31b8",
"code": 20001,
"data": {
"duration": {
"alg_process_time": 0,
"created_timestamp": 1759201989,
"pull_timestamp": 1759201989,
"repost_time": 0,
"upload_time": 0,
"waiting_time": 0
},
"error_code": 20001,
"error_msg": "ALGO_MODEL_CRASH",
"extra": {},
"media_info_list": [],
"msg_id": "c1b09cb2-6e05-4d21-55ab-r007b1f21bec",
"parameter": null
},
"msg": "ALGO_MODEL_CRASH",
"msg_id": "c1b09cb2-6e05-4d21-55ab-r007b1f21bec"
},
"progress": 1,
"predict_elapsed": 10000,
"create_time": 1759201989444,
"task_id": "t_mt1a3i5n7be8d575cc-2ffb-4e0c-85a8-1824110e31b8",
"custom_task_id": "",
"trace_id": "",
"client_info": "",
"init_images": null
}
}通用的错误代码与信息
详见 API 错误码
SDK 调用示例
Python
import requests
import json
from sign_sdk import sign
def passerby_removal_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": {
"expand_params": json.dumps({
"parameter": {
"generate_num": 1,
"step": 25,
"seed": -1,
}
}, ensure_ascii=False),
"result_type": "0",
},
}
payload = {
"task": "/v1/Passersby_Elimination/453194",
"task_type": "formula",
"init_images": [
{
"url": "https://example.com/input.jpg",
"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)
try:
signer = sign.Signer(key, secret)
signed_request = signer.sign(url, method, headers, body)
session = requests.Session()
response = session.send(signed_request)
print(f"Status: {response.status_code}")
print(f"Response: {response.text}")
except Exception as e:
print(f"Error: {str(e)}")
if __name__ == "__main__":
passerby_removal_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 := "POST"
headers := make(http.Header)
headers.Set(signer.HeaderHost, "openapi.meitu.com")
headers.Set("Content-Type", "application/json")
body := `{
"task": "/v1/Passersby_Elimination/453194",
"task_type": "formula",
"init_images": [{
"url": "https://example.com/input.jpg",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1"
}
}],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"expand_params\":\"{\\\"parameter\\\":{\\\"generate_num\\\":1,\\\"step\\\":25,\\\"seed\\\":-1}}\",\"result_type\":\"0\"}}",
"sync_timeout": 30
}`
req, err := signObj.Sign(url, method, headers, body)
if err != nil {
fmt.Println("Failed to sign request:", err)
return
}
client := http.DefaultClient
resp, err := client.Do(req)
if err != nil {
fmt.Println("Failed to send request:", err)
return
}
defer resp.Body.Close()
bodyBytes, err := io.ReadAll(resp.Body)
if err != nil {
fmt.Println("Read response failed:", err)
return
}
fmt.Println("Response:", resp.StatusCode, string(bodyBytes))
}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'
];
$expandParams = json_encode([
"parameter" => [
"generate_num" => 1,
"step" => 25,
"seed" => -1
]
]);
$innerParams = json_encode([
"rsp_media_type" => "url",
"parameter" => [
"expand_params" => $expandParams,
"result_type" => "0"
]
]);
$body = json_encode([
"task" => "/v1/Passersby_Elimination/453194",
"task_type" => "formula",
"init_images" => [
[
"url" => "https://example.com/input.jpg",
"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;
}
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.MalformedURLException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import com.meitu.openai.common.Signer;
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/Passersby_Elimination/453194\",\n" +
" \"task_type\": \"formula\",\n" +
" \"init_images\": [{\n" +
" \"url\": \"https://example.com/input.jpg\",\n" +
" \"profile\": {\n" +
" \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
" \"version\": \"v1\"\n" +
" }\n" +
" }],\n" +
" \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"expand_params\\\":\\\"{\\\\\\\"parameter\\\\\\\":{\\\\\\\"generate_num\\\\\\\":1,\\\\\\\"step\\\\\\\":25,\\\\\\\"seed\\\\\\\":-1}}\\\",\\\"result_type\\\":\\\"0\\\"}}\",\n" +
" \"sync_timeout\": 30\n" +
"}";
Map<String, String> signedHeaders = signer.sign(url, method, headers, body);
System.out.println("signedHeader: " + signedHeaders);
try {
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();
System.out.println(status);
InputStream inputStream = status >= 400
? connection.getErrorStream()
: connection.getInputStream();
BufferedReader in = new BufferedReader(new InputStreamReader(inputStream));
String inputLine;
StringBuilder response = new StringBuilder();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println("======");
System.out.println(response.toString());
System.out.println("======");
} catch (MalformedURLException e) {
e.printStackTrace();
}
}
}