描述

本接口用于云端进行显著性检测抠图，支持对图片中的前景主体进行自动分离。建议原图大小控制在 3MB 以内，以保证较好的抠图速度与效果。

版本

1.0

图片要求

图片格式：JPG、PNG
图片大小：不超过 3MB

调用 URL

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

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

是否必选	参数名	类型	参数说明
必选	params	string	算法参数（JSON 字符串）
必选	init_images	object[]	图片列表
必选	task	string	固定 /v1/photo_scissors_oversea/8000555
必选	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，抠图结果以短期有效的 URL 返回；jpg 表示 base64
必选	parameter	object	算法核心参数对象

parameter 算法参数详情

是否必选	参数名	类型	参数说明
可选	nMask	bool	是否返回 mask 图；true 只返回 mask 图，false 返回结果图
可选	model_type	int	抠图模型类型：0 人像抠图，1 商品抠图，2 图形抠图；不传时由模型自动判断
可选	userboxes	string	为图像添加用户交互框，坐标使用相对坐标；示例：[[[0.01, 0.814], [0.12, 0.814], [0.12, 0.96], [0.01, 0.96]]]
可选	blackwhite	bool	是否返回黑白图；true 仅返回黑白 mask 图，false 返回四通道 Mask 图（默认）
可选	nbox	bool	是否返回目标位置 top_x、top_y、bottom_x、bottom_y；默认 false

输入值示例

{
  "task": "/v1/photo_scissors_oversea/8000555",
  "task_type": "formula",
  "init_images": [
    {
      "url": "https://my-material.obs.cn-north-4.myhuaweicloud.com/material-pre/m7eha8y5-rgrrak1.jpg",
      "profile": {
        "media_profiles": {
          "media_data_type": "url"
        },
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"nMask\":false,\"model_type\":0,\"userboxes\":\"[[[0.01, 0.814], [0.12, 0.814], [0.12, 0.96], [0.01, 0.96]]]\",\"blackwhite\":false,\"nbox\":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	任务进度
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[]	抠图结果图片 URL 列表
parameters	object	额外返回参数

parameters 字段说明

字段	类型	说明
bottom_x	string	右下角 X 坐标
bottom_y	string	右下角 Y 坐标
exist_salient	bool	是否存在显著性目标
Kind	int	抠图类型：0 人像，1 商品，2 图形
process_time	number	算法处理耗时
pull_time	number	拉取耗时
rsp_media_type	string	返回媒体类型；jpg 表示 media_data 是经过 Base64 编码的图片
top_x	string	左上角 X 坐标
top_y	string	左上角 Y 坐标
use_fe	bool	是否使用前景估计
version	string	算法版本号

返回值示例

请求成功返回示例

{
  "request_id": "",
  "trace_id": "",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 10,
    "result": {
      "id": "task_id",
      "urls": [
        "https://example.com/output.png"
      ],
      "parameters": {
        "Kind": 0,
        "bottom_x": "None",
        "bottom_y": "None",
        "exist_salient": true,
        "process_time": 2596.703290939331,
        "pull_time": 933.626651763916,
        "rsp_media_type": "url",
        "top_x": "None",
        "top_y": "None",
        "use_fe": true,
        "version": "2.9.4"
      }
    },
    "progress": 1,
    "predict_elapsed": 30000,
    "create_time": 1762337530390,
    "task_id": "task_id",
    "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": "sync timeout",
  "tips": null,
  "data": {
    "status": 9,
    "result": {},
    "progress": 0.5,
    "predict_elapsed": 30000,
    "create_time": 1762337530390,
    "task_id": "task_id",
    "custom_task_id": "",
    "trace_id": "",
    "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": {
      "error_code": 20001,
      "error_msg": "PROCESS_ERROR"
    },
    "progress": 0,
    "predict_elapsed": 0,
    "create_time": 1762337530390,
    "task_id": "task_id",
    "custom_task_id": "",
    "trace_id": "",
    "client_info": "",
    "init_images": null
  }
}

通用的错误代码与信息

当前 API 特有错误：

错误码	错误信息	说明
20001	PROCESS_ERROR	处理错误

其他错误详见 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": {
            "nMask": False,
            "model_type": 0,
            "userboxes": "[[[0.01, 0.814], [0.12, 0.814], [0.12, 0.96], [0.01, 0.96]]]",
            "blackwhite": False,
            "nbox": False,
        },
    }
    payload = {
        "task": "/v1/photo_scissors_oversea/8000555",
        "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)

    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/photo_scissors_oversea/8000555",
  "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\":{\"nMask\":false,\"model_type\":0,\"userboxes\":\"[[[0.01, 0.814], [0.12, 0.814], [0.12, 0.96], [0.01, 0.96]]]\",\"blackwhite\":false,\"nbox\":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' => [
        'nMask' => false,
        'model_type' => 0,
        'userboxes' => '[[[0.01, 0.814], [0.12, 0.814], [0.12, 0.96], [0.01, 0.96]]]',
        'blackwhite' => false,
        'nbox' => false,
    ],
]);

$body = json_encode([
    'task' => '/v1/photo_scissors_oversea/8000555',
    '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}\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/photo_scissors_oversea/8000555\",\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\\\":{\\\"nMask\\\":false,\\\"model_type\\\":0,\\\"userboxes\\\":\\\"[[[0.01, 0.814], [0.12, 0.814], [0.12, 0.96], [0.01, 0.96]]]\\\",\\\"blackwhite\\\":false,\\\"nbox\\\":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);
        }
    }
}

智能抠图-海外版

描述

版本