描述

本接口用于发起智能消除投递任务。任务投递成功后异步执行算法，用户可通过查询接口主动查询算法执行结果，也可通过请求时的回调地址获取算法结果。

版本

2.0

图片要求

图片格式：JPG、JPEG、PNG、BMP、HEIF。
图片文件大小：30 MB。
本接口需要两张图片，依次为原图和 mask 图。

调用 URL

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

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

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

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

是否必选	参数名	类型	参数说明
必选	url	string	图片 URL 或 base64；第一项为原图，第二项为 mask 图
可选	profile	object	多媒体参数

profile 参数，结构说明如下

是否必选	参数名	类型	参数说明
可选	media_extra	object	多媒体附加参数
可选	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	消除算法参数对象

按照统一网关的五字段请求结构，rsp_media_type 放在 params 字符串反序列化后的对象中，并与 parameter 同级；消除算法字段仅放在 parameter 内。

parameter 算法参数详情

是否必选	参数名	类型	参数说明
可选	text_remove_param	object	文字水印特殊参数

text_remove_param 参数详情

是否必选	参数名	类型	参数说明
可选	is_text	bool	输入图片是否为文档类型图片，默认 `false`
可选	is_translucent_watermark	bool	输入图片中的水印是否为半透明水印，默认 `false`

当 is_text 和 is_translucent_watermark 均为 true 时，接口会直接执行半透明水印消除任务。该功能只针对半透明水印场景设计，在其他场景中效果不佳。

输入值示例

{
  "task": "/v1/AI_Remove2/477119",
  "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.jpg",
      "profile": {
        "media_profiles": {
          "media_data_type": "url"
        },
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"text_remove_param\":{\"is_text\":false,\"is_translucent_watermark\":false}}}",
  "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	任务进度，例如 `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[]	结果图片地址列表

返回值示例

请求成功返回示例

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": "t_mt1a3i5n7bdb4183fe-8f91-4b1c-ae95-402b6f48613b",
      "urls": [
        "https://aigcp.meitudata.com/effect/sys_kfpt/xiuxiu/67af4645-0f48-4fad-8999-748af70b30dc.png"
      ]
    },
    "progress": 1,
    "predict_elapsed": 0,
    "create_time": 1718172000000,
    "task_id": "t_mt1a3i5n7bdb4183fe-8f91-4b1c-ae95-402b6f48613b",
    "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": {
      "ErrorCode": 20001,
      "ErrorMsg": "PROCESS_ERROR",
      "Data": null
    },
    "progress": 0,
    "predict_elapsed": 0,
    "create_time": 1718172000000,
    "task_id": "",
    "custom_task_id": "",
    "trace_id": "trace_1234567890",
    "client_info": "",
    "init_images": null
  }
}

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

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

通用的错误代码与信息

详见 API 错误码

SDK 调用示例

以下 SDK 示例均签名并发送同一个实际请求 body；init_images 第一项为原图，第二项为 mask 图。

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": {
            "text_remove_param": {
                "is_text": False,
                "is_translucent_watermark": False,
            }
        },
    }
    payload = {
        "task": "/v1/AI_Remove2/477119",
        "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.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)

    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_Remove2/477119",
  "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.jpg",
      "profile": {
        "media_profiles": {"media_data_type": "url"},
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"text_remove_param\":{\"is_text\":false,\"is_translucent_watermark\":false}}}",
  "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' => [
        'text_remove_param' => [
            'is_text' => false,
            'is_translucent_watermark' => false,
        ],
    ],
]);

$body = json_encode([
    'task' => '/v1/AI_Remove2/477119',
    '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.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}\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_Remove2/477119\",\n" +
                "  \"task_type\": \"formula\",\n" +
                "  \"init_images\": [\n" +
                "    {\n" +
                "      \"url\": \"https://example.com/original.jpg\",\n" +
                "      \"profile\": {\n" +
                "        \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
                "        \"version\": \"v1\"\n" +
                "      }\n" +
                "    },\n" +
                "    {\n" +
                "      \"url\": \"https://example.com/mask.jpg\",\n" +
                "      \"profile\": {\n" +
                "        \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
                "        \"version\": \"v1\"\n" +
                "      }\n" +
                "    }\n" +
                "  ],\n" +
                "  \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"text_remove_param\\\":{\\\"is_text\\\":false,\\\"is_translucent_watermark\\\":false}}}\",\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);
        }
    }
}

智能消除 2.0

描述

版本

图片要求

调用 URL

调用方法

权限

请求参数

输入值示例

返回值说明

返回值示例

请求成功返回示例

需要查询返回示例

请求失败返回示例

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

通用的错误代码与信息

SDK 调用示例

Python

Go

PHP

Java