商品图修复

描述

商品图修复。

版本

1.0

图片要求

  • 支持的图片格式:PNG、JPEG。
  • 支持的图片大小:不超过 20 MB。

调用 URL

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

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

是否必选参数名类型参数说明
必选paramsstring算法参数(JSON 字符串)
必选init_imagesobject[]多媒体文件列表
必选taskstring固定 /v1/goods_image_repair/493222
必选task_typestring固定 formula
可选sync_timeoutint默认 30,同步超时时间

init_images 多媒体文件参数,结构说明如下

是否必选参数名类型参数说明
必选urlstring图片 URL 或 base64
必选profileobject属性信息描述

profile 属性信息描述

是否必选参数名类型参数说明
必选media_profilesobject媒体属性信息
必选versionstring固定 v1

media_profiles 媒体属性信息

是否必选参数名类型参数说明
必选media_data_typestringurl 表示 URL;jpg 等类型表示 base64

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

是否必选字段类型说明
可选rsp_media_typestring默认 urljpg 表示以 Base64 编码格式返回,url 表示以 URL 返回
必选parameterobject算法核心参数对象

parameter 算法参数详情

是否必选参数名类型参数说明
可选versionstring算法版本,例如 1.0.02.0.0,默认 1.0.0
可选create_valueint创造力数值,范围 -100~100,默认 0
可选hdr_valueintHDR 增强数值,范围 0~100,默认 30
可选resemblance_valueint相似度,范围 0~100,默认 100
可选promptstring提示词,默认空字符串
可选sr_numint放大倍数,可选 24,默认 2;2 倍最大支持原图 2560×2560,4 倍最大支持原图 1280×1280
可选portraits_xzint是否开启写真场景,默认 00 不开启,1 开启
可选custom_size_flagint是否开启自适应,默认 00 不开启,1 开启
原文未说明guidance_valueint仅据原文 JSON 示例确定类型为 int、示例值为 120;含义、必选性、取值范围和默认值原文未说明
原文未说明modeint仅据原文 JSON 示例确定类型为 int、示例值为 2;含义、必选性、取值范围和默认值原文未说明
原文未说明algorithm_versionstring仅据原文 JSON 示例确定类型为 string、示例值为 v3;含义、必选性、取值范围和默认值原文未说明

输入值示例

{
  "task": "/v1/goods_image_repair/493222",
  "task_type": "formula",
  "init_images": [
    {
      "url": "https://file.style3d.com/app/intellistyle/company/ai/1784340525931/CAL020-DDPD.png",
      "profile": {
        "media_profiles": {
          "media_data_type": "url"
        },
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"version\":\"1.0.0\",\"create_value\":100,\"hdr_value\":30,\"resemblance_value\":100,\"prompt\":\"\",\"sr_num\":2,\"portraits_xz\":0,\"custom_size_flag\":1,\"guidance_value\":120,\"mode\":2,\"algorithm_version\":\"v3\"}}",
  "sync_timeout": 30
}

返回值说明

注意,生成的结果,会定期清理,请及时下载保存
字段类型说明
request_idstring请求标识
trace_idstring链路追踪标识
codeint业务状态码,0 表示请求受理成功
error_codeint错误码,成功时为 0
messagestring业务信息
tipsany补充提示,可为 null
dataobject任务状态和算法结果

data 中单个元素的字段说明

字段类型说明
statusint状态码:-1 未找到任务;0 创建成功;1 执行中;2 失败;9 超时,使用查询接口查询;10 成功
resultobject算法结果
progressnumber任务进度
predict_elapsedint预计耗时,毫秒
create_timeint64创建时间戳,毫秒
task_idstring任务 ID
custom_task_idstring客户自定义任务 ID
trace_idstring链路追踪标识
client_infostring客户端信息
init_imagesobject[]/null输入媒体回显

data.result 中字段说明

字段类型说明
idstring任务唯一标识
urlsarray生成的图片 URL 列表
parametersobject算法参数信息,包含响应媒体类型和算法版本
dataobject算法返回的详细数据
msgstring算法返回信息
msg_idstring消息 ID
imagesarray生成的媒体 URL 列表
mtlab_resobject算法底层返回结果
media_info_listarray媒体信息列表

data.result.parameters 中字段说明

字段类型说明
rsp_media_typestring响应媒体类型
versionstring算法版本号

data.result.data 中字段说明

字段类型说明
durationobject各阶段耗时统计
error_codeint算法错误码,0 表示成功
error_msgstring算法错误信息
extraobject扩展元数据信息
media_info_listarray媒体信息列表
msg_idstring消息 ID
parameterobject参数回显

data.result.data.duration 中字段说明

字段类型说明
alg_process_timeint算法处理耗时,毫秒
created_timestampint任务创建时间戳
pull_timestampint拉取资源时间戳
repost_timeint重新处理耗时,毫秒
upload_timeint资源上传耗时,毫秒
waiting_timeint排队等待耗时,毫秒

data.result.data.extra.trans_meta 中字段说明

字段类型说明
req_metaarray请求媒体元数据列表;元素中的 media_type 表示媒体类型
rsp_metaarray响应媒体元数据列表;元素包含 heightmedia_typesizewidth

data.result.media_info_list 及 data.result.data.media_info_list 中单个元素的字段说明

字段类型说明
media_datastring媒体数据 URL
media_extraobject/null媒体附加信息
media_profilesobject媒体配置信息

media_profiles 字段说明

字段类型说明
media_data_heightint媒体数据高度,像素
media_data_sizeint媒体数据大小,字节
media_data_typestring媒体数据类型,例如 url
media_data_widthint媒体数据宽度,像素

data.result.mtlab_res 中字段说明

字段类型说明
ErrorCodeint底层错误码
ErrorMsgstring底层错误信息
error_codeint错误码(兼容字段)
error_msgstring错误信息(兼容字段)
media_info_listarray/null媒体信息列表
msg_idstring消息 ID
parameterobject/null参数信息

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

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

返回值示例

请求成功返回示例

{
  "request_id": "",
  "trace_id": "",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 10,
    "result": {
      "id": "t_mt1a3i5n7b8e22d6dc-44ee-4834-a6a3-e30e2292f5d8",
      "urls": [
        "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d69631a2-d6b3-4bac-6d52-7b4b46fe11a5.jpeg"
      ],
      "parameters": {
        "rsp_media_type": "url",
        "version": "1.0.35"
      },
      "data": {
        "duration": {
          "alg_process_time": 4505,
          "created_timestamp": 1784536063,
          "pull_timestamp": 1784536063,
          "repost_time": 0,
          "upload_time": 211,
          "waiting_time": 135
        },
        "error_code": 0,
        "error_msg": "success",
        "extra": {
          "trans_meta": {
            "req_meta": [
              {
                "media_type": "image"
              }
            ],
            "rsp_meta": [
              {
                "height": 3314,
                "media_type": "image",
                "size": 1726,
                "width": 1977
              }
            ]
          }
        },
        "media_info_list": [
          {
            "media_data": "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d69631a2-d6b3-4bac-6d52-7b4b46fe11a5.jpeg",
            "media_extra": null,
            "media_profiles": {
              "media_data_height": 3314,
              "media_data_size": 1767986,
              "media_data_type": "url",
              "media_data_width": 1977
            }
          }
        ],
        "msg_id": "130a0c98-b631-4ef8-4b1d-r009b6117553",
        "parameter": {
          "rsp_media_type": "url",
          "version": "1.0.35"
        }
      },
      "msg": "success",
      "msg_id": "130a0c98-b631-4ef8-4b1d-r009b6117553",
      "images": [
        "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d69631a2-d6b3-4bac-6d52-7b4b46fe11a5.jpeg"
      ],
      "mtlab_res": {
        "ErrorCode": 0,
        "ErrorMsg": "",
        "error_code": 0,
        "error_msg": "",
        "media_info_list": null,
        "msg_id": "130a0c98-b631-4ef8-4b1d-r009b6117553",
        "parameter": null
      },
      "media_info_list": [
        {
          "media_data": "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d69631a2-d6b3-4bac-6d52-7b4b46fe11a5.jpeg",
          "media_extra": null,
          "media_profiles": {
            "media_data_height": 3314,
            "media_data_size": 1767986,
            "media_data_type": "url",
            "media_data_width": 1977
          }
        }
      ]
    },
    "progress": 1,
    "predict_elapsed": 10000,
    "create_time": 1784536063640,
    "task_id": "t_mt1a3i5n7b8e22d6dc-44ee-4834-a6a3-e30e2292f5d8",
    "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": "success",
  "tips": null,
  "data": {
    "status": 9,
    "result": {
      "id": "t_mt1a3i5n7b8e22d6dc-44ee-4834-a6a3-e30e2292f5d8"
    },
    "progress": 0,
    "predict_elapsed": 10000,
    "create_time": 1784536063640,
    "task_id": "t_mt1a3i5n7b8e22d6dc-44ee-4834-a6a3-e30e2292f5d8",
    "custom_task_id": "",
    "trace_id": "70b45244-3360-4859-bc01-9ec4435a81e8",
    "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,
      "message": "PROCESS_ERROR"
    },
    "progress": 0,
    "predict_elapsed": 0,
    "create_time": 0,
    "task_id": "",
    "custom_task_id": "",
    "trace_id": "",
    "client_info": "",
    "init_images": null
  }
}

通用的错误代码与信息

详见 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": {
            "version": "1.0.0",
            "create_value": 100,
            "hdr_value": 30,
            "resemblance_value": 100,
            "prompt": "",
            "sr_num": 2,
            "portraits_xz": 0,
            "custom_size_flag": 1,
            "guidance_value": 120,
            "mode": 2,
            "algorithm_version": "v3",
        },
    }
    payload = {
        "task": "/v1/goods_image_repair/493222",
        "task_type": "formula",
        "init_images": [
            {
                "url": "https://file.style3d.com/app/intellistyle/company/ai/1784340525931/CAL020-DDPD.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/goods_image_repair/493222",
  "task_type": "formula",
  "init_images": [{
    "url": "https://file.style3d.com/app/intellistyle/company/ai/1784340525931/CAL020-DDPD.png",
    "profile": {
      "media_profiles": {"media_data_type": "url"},
      "version": "v1"
    }
  }],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"version\":\"1.0.0\",\"create_value\":100,\"hdr_value\":30,\"resemblance_value\":100,\"prompt\":\"\",\"sr_num\":2,\"portraits_xz\":0,\"custom_size_flag\":1,\"guidance_value\":120,\"mode\":2,\"algorithm_version\":\"v3\"}}",
  "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' => [
        'version' => '1.0.0',
        'create_value' => 100,
        'hdr_value' => 30,
        'resemblance_value' => 100,
        'prompt' => '',
        'sr_num' => 2,
        'portraits_xz' => 0,
        'custom_size_flag' => 1,
        'guidance_value' => 120,
        'mode' => 2,
        'algorithm_version' => 'v3',
    ],
]);

$body = json_encode([
    'task' => '/v1/goods_image_repair/493222',
    'task_type' => 'formula',
    'init_images' => [
        [
            'url' => 'https://file.style3d.com/app/intellistyle/company/ai/1784340525931/CAL020-DDPD.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/goods_image_repair/493222\",\n" +
                "  \"task_type\": \"formula\",\n" +
                "  \"init_images\": [{\n" +
                "    \"url\": \"https://file.style3d.com/app/intellistyle/company/ai/1784340525931/CAL020-DDPD.png\",\n" +
                "    \"profile\": {\n" +
                "      \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
                "      \"version\": \"v1\"\n" +
                "    }\n" +
                "  }],\n" +
                "  \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"version\\\":\\\"1.0.0\\\",\\\"create_value\\\":100,\\\"hdr_value\\\":30,\\\"resemblance_value\\\":100,\\\"prompt\\\":\\\"\\\",\\\"sr_num\\\":2,\\\"portraits_xz\\\":0,\\\"custom_size_flag\\\":1,\\\"guidance_value\\\":120,\\\"mode\\\":2,\\\"algorithm_version\\\":\\\"v3\\\"}}\",\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);
        }
    }
}