描述

本接口用于发起 AI 无痕消除任务，根据图像中的涂抹区域进行计算，使生成后的图像具有合理性，获得更好的生成式消除效果。

版本

1.0

效果样例

输入图片	输出图片

图片要求

支持 JPG、PNG 格式。
必须依次传入两张图片：第一张为原图，第二张为标示待消除涂抹区域的 mask 图。
输入图片最大宽高目前统一限制为 4096；原图宽高超过上限时，算法结果会缩放后返回。

调用 URL

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

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

是否必选	参数名	类型	参数说明
必选	params	string	推理参数（JSON 字符串）
必选	init_images	object[]	图片文件列表；需传两张图片，第一张为原图，第二张为 mask 图
必选	task	string	固定 `/v1/AI_Seamless_Elimination/467915`
必选	task_type	string	固定 `formula`
可选	sync_timeout	int	默认 `30`；`-1` 表示不等待。同步等待超时后返回状态 `9`，需使用查询接口获取结果

init_images 图片参数，结构说明如下

是否必选	参数名	类型	参数说明
必选	url	string	图片 URL 或 base64
可选	profile	object	多媒体参数

profile 多媒体参数，结构说明如下

是否必选	参数名	类型	参数说明
可选	media_extra	object	多媒体附加参数；原文未进一步定义其内部字段
可选	media_profiles	object	多媒体描述
可选	version	string	源文请求示例中传 `v1`

media_profiles 多媒体描述，结构说明如下

是否必选	参数名	类型	参数说明
可选	media_data_type	string	`url` 表示多媒体文件以 URL 形式传输；`jpg` 表示多媒体文件以 JPG base64 编码传输

params 推理参数是 JSON 字符串，其结构说明如下

是否必选	字段	类型	说明
可选	rsp_media_type	string	默认 `url`；`jpg` 表示结果图像以 base64 编码返回，`url` 表示结果图像以 URL 返回
必选	parameter	object	消除算法参数对象

parameter 算法参数详情

是否必选	参数名	类型	参数说明
可选	generate_num	int	返回图像数量，默认 `4`，取值范围 `1`～`10`
可选	seed	int	随机种子，范围 `[-1,65535]`；不传时接口内部默认为 `0`。种子固定时每次返回效果相同，推荐调用方自行生成随机种子并传入，以便复现 badcase；`-1` 表示随机种子，每次返回不同效果
可选	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`
可选	auto_adjust_mask_edge	bool	是否在算法内部自适应调整输入 mask，并根据调整后的 mask 执行消除，默认 `true`。mask 来自分割算法时，为避免未分割干净的边缘像素影响结果，推荐开启；待消除主体周围有明显阴影时，为使结果更自然，也推荐开启
可选	return_modified_mask	bool	是否返回实际执行消除时使用的 mask，默认 `false`。由于 `auto_adjust_mask_edge` 可能修改 mask，可用此参数获取修改后的 mask 以便调试或后处理。为 `true` 时同时返回 RGB 结果图和单通道 mask 图，共 `generate_num * 2` 张；返回 mask 图的 `media_profiles` 中会增加 `is_mask=true` 标志
可选	high_quality_encode	bool	是否以高质量、低压缩率方式编码并返回结果图像，默认 `false`；图像内容不变，质量更好，但接口耗时会增加
可选	global_instances_mask	object	消除时保护主体的专用字段，包含 `media_data` 和 `media_profiles`，格式与前述多媒体定义相同，用于额外传入全图实例分割 mask：实例像素值依次为 `1`、`2` 等，`0` 表示背景。该 mask 用于保护原图主体区域不被修改，优先级高于 `auto_adjust_mask_edge`；即使 `auto_adjust_mask_edge=true`，也不会修改受保护区域内的像素

输入值示例

{
  "task": "/v1/AI_Seamless_Elimination/467915",
  "task_type": "formula",
  "init_images": [
    {
      "url": "https://example.com/original.jpg",
      "profile": {
        "media_profiles": {"media_data_type": "url"},
        "version": "v1"
      }
    },
    {
      "url": "https://example.com/mask.png",
      "profile": {
        "media_profiles": {"media_data_type": "url"},
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"generate_num\":1}}",
  "sync_timeout": 30
}

返回值说明

注意，生成的结果图会在 24 小时后定期清理，请及时下载保存。

字段	类型	说明
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` 成功
msg	string	多媒体文件相关属性信息描述
result	object	算法结果
progress	number	任务进度，例如 `0.1`、`0.85`、`1`
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	任务 ID
urls	string[]	结果图片地址列表；当 `rsp_media_type` 为 `jpg` 时，按源文说明返回 base64 编码的结果图像

返回值示例

请求成功返回示例

Response Status：200

content-type 为 application/json; charset=utf-8

{
  "request_id": "req_1234567890",
  "trace_id": "trace_1234567890",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 10,
    "result": {
      "id": "50309bd5-a827-4125-bc96-62039c93770b",
      "urls": ["https://obs.mtlab.meitu.com/mtopen/rF5GIhp5ReLKgLV91CKj5BO1q2FTLMmc/MTY5Mjg1MzIwMA==/1c39ef92-04f1-40b4-5b7e-8fcfca0c11ea.png"]
    },
    "progress": 1,
    "predict_elapsed": 0,
    "create_time": 1718172000000,
    "task_id": "50309bd5-a827-4125-bc96-62039c93770b",
    "custom_task_id": "",
    "trace_id": "trace_1234567890",
    "client_info": "",
    "init_images": null
  }
}

需要查询返回示例

当 data.status 为 9 时，使用查询接口和返回的任务 ID 查询结果。

Response Status：200

content-type 为 application/json; charset=utf-8

{
  "request_id": "req_1234567890",
  "trace_id": "trace_1234567890",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 9,
    "result": {"id": "task_1234567890"},
    "progress": 0,
    "predict_elapsed": 10000,
    "create_time": 1718172000000,
    "task_id": "task_1234567890",
    "custom_task_id": "",
    "trace_id": "trace_1234567890",
    "client_info": "",
    "init_images": null
  }
}

请求失败返回示例

Response Status：400

content-type 为 application/json; charset=utf-8

{
  "request_id": "req_1234567890",
  "trace_id": "trace_1234567890",
  "code": 20001,
  "error_code": 20001,
  "message": "PROCESS_ERROR",
  "tips": null,
  "data": {
    "status": 2,
    "result": {
      "id": "t_mt1a3i5n7bac811796-59d6-4a00-bd59-8cfabc82df64",
      "msg": "ERROR msg"
    },
    "progress": 1,
    "predict_elapsed": 0,
    "create_time": 1718172000000,
    "task_id": "t_mt1a3i5n7bac811796-59d6-4a00-bd59-8cfabc82df64",
    "custom_task_id": "",
    "trace_id": "trace_1234567890",
    "client_info": "",
    "init_images": null
  }
}

通用的错误代码与信息

详见 API 错误码

SDK 调用示例

以下示例均对最终发送的完整 JSON body 进行签名。

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": {"generate_num": 1},
    }
    payload = {
        "task": "/v1/AI_Seamless_Elimination/467915",
        "task_type": "formula",
        "init_images": [
            {
                "url": "https://example.com/original.jpg",
                "profile": {
                    "media_profiles": {"media_data_type": "url"},
                    "version": "v1",
                },
            },
            {
                "url": "https://example.com/mask.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/AI_Seamless_Elimination/467915",
  "task_type": "formula",
  "init_images": [
    {"url":"https://example.com/original.jpg","profile":{"media_profiles":{"media_data_type":"url"},"version":"v1"}},
    {"url":"https://example.com/mask.png","profile":{"media_profiles":{"media_data_type":"url"},"version":"v1"}}
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"generate_num\":1}}",
  "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' => ['generate_num' => 1],
]);
$body = json_encode([
    'task' => '/v1/AI_Seamless_Elimination/467915',
    'task_type' => 'formula',
    'init_images' => [
        [
            'url' => 'https://example.com/original.jpg',
            'profile' => [
                'media_profiles' => ['media_data_type' => 'url'],
                'version' => 'v1',
            ],
        ],
        [
            'url' => 'https://example.com/mask.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/AI_Seamless_Elimination/467915\",\n" +
                "  \"task_type\": \"formula\",\n" +
                "  \"init_images\": [\n" +
                "    {\"url\":\"https://example.com/original.jpg\",\"profile\":{\"media_profiles\":{\"media_data_type\":\"url\"},\"version\":\"v1\"}},\n" +
                "    {\"url\":\"https://example.com/mask.png\",\"profile\":{\"media_profiles\":{\"media_data_type\":\"url\"},\"version\":\"v1\"}}\n" +
                "  ],\n" +
                "  \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"generate_num\\\":1}}\",\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);
        }
    }
}

AI无痕消除

描述

版本

效果样例

图片要求

调用 URL

调用方法

权限

请求参数

输入值示例

返回值说明

返回值示例

请求成功返回示例

需要查询返回示例

请求失败返回示例

通用的错误代码与信息

SDK 调用示例

Python

Go

PHP

Java