图像画质修复 V3

描述

本接口用于发起图像画质修复任务。任务投递成功后开始异步执行算法;调用方可通过查询接口主动查询算法执行结果,也可通过请求中的回调地址获取算法结果。

图片要求

  • 图片格式:JPG、JPEG、BMP。
  • 图片文件大小上限:30 MB。
  • 目前仅支持以 URL 形式传入图片。

调用 URL

    正式环境:https://openapi.meitu.com
    任务提交接口:https://openapi.meitu.com/api/v1/sdk/sync/push
    同步任务名称(task):/v1/High_Definition_V3/466658
    异步任务名称(task):/v1/High_Definition_V3/466659
    任务类型(task_type):formula

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

请求体固定由以下五个顶层字段组成:

是否必选参数名类型参数说明
必选paramsstring推理参数;值为序列化后的 JSON 字符串
必选init_imagesobject[]图片文件列表;目前仅支持 URL 形式
必选taskstring同步任务固定为 /v1/High_Definition_V3/466658;异步任务固定为 /v1/High_Definition_V3/466659
必选task_typestring固定 formula
可选sync_timeoutint默认 30-1 表示不等待。同步等待超时后返回状态 9,需使用查询接口获取结果

init_images 图片参数

是否必选参数名类型参数说明
必选urlstring图片地址;目前仅支持 URL
可选profileobject多媒体参数

profile 多媒体参数

是否必选参数名类型参数说明
可选media_extraobject多媒体附加参数;源文未进一步定义其内部字段
可选media_profilesobject多媒体描述
可选versionstring源文请求示例中传 v1

media_profiles 多媒体描述

是否必选参数名类型参数说明
可选media_data_typestringurl 表示以 URL 传输;jpg 表示以 JPG base64 编码传输。当前接口仅支持 URL 形式请求,请求时使用 url

params 是 JSON 字符串,反序列化后的结构如下:

是否必选字段类型说明
可选rsp_media_typestring公共响应媒体类型,默认 urljpg 表示结果图像以 base64 编码返回,url 表示以 URL 返回
必选parameterobject图像画质修复 V3 算法参数对象

rsp_media_typeparameter 同级,所有算法字段仅放在 parameter 内。源文的参数表曾将 rsp_media_type 写入 parameter,并在一处使用 base64 这一取值名称;同一源文的顶层字段说明、请求语义和返回媒体字段均使用 jpg/url。本文按统一网关结构归一为公共字段,并使用有完整输入、输出映射的 jpg/url 取值。

parameter 算法参数详情

是否必选参数名类型参数说明
可选ir_modeint效果模式,默认 33 表示 Wink 超清档(V3),4 表示美图秀秀超清和 Wink 人像增强
可选save_photo_formatint保存图片格式,默认 11 表示 JPG,2 表示 PNG
可选use_denoiseint是否开启背景修复,默认 11 开启,0 关闭
可选use_hd_face_optint是否开启人像修复升级,默认 01 开启,0 关闭
可选max_widthint返回图片的最大宽度,默认 -1
可选max_heightint返回图片的最大高度,默认 -1
可选repost_urlstring业务方提供的 POST 回调地址
可选sr_numint默认 4
可选return_format_typestring返回图片格式,默认 png;可选 jpegjpgpngwebp,其他字符串按 png 返回

输入值示例

{
  "task": "/v1/High_Definition_V3/466658",
  "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\":{\"ir_mode\":3}}",
  "sync_timeout": 30
}

调用异步任务时,仅将 task 改为 /v1/High_Definition_V3/466659

返回值说明

字段类型说明
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输入媒体回显

成功时 result 字段

字段类型说明
idstring任务 ID,可用于查询任务状态
media_info_listobject[]多媒体结果列表
parameterobject返回信息类型标识

media_info_list 单个元素

字段类型说明
media_datastringmedia_data_typejpg 时是 JPG base64;为 url 时是图片 URL
media_profilesobject多媒体文件属性信息

返回 parameter 字段

字段类型说明
rsp_media_typestringjpg 表示 media_data 是 JPG base64;url 表示图片 URL

返回 media_profiles 字段

字段类型说明
media_data_typestringjpg 表示 media_data 是 JPG base64;url 表示图片 URL

失败时 result 字段

字段类型说明
ErrorCodeint算法错误代码
ErrorMsgstring算法错误信息
Datastring/null具体错误信息;无数据时为 null

返回值示例

请求成功返回示例(status=10)

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": "task_1234567890",
      "parameter": {"rsp_media_type": "url"},
      "media_info_list": [
        {
          "media_data": "https://example.com/result.jpg",
          "media_profiles": {"media_data_type": "url"}
        }
      ]
    },
    "progress": 1,
    "predict_elapsed": 0,
    "create_time": 1718172000000,
    "task_id": "task_1234567890",
    "custom_task_id": "",
    "trace_id": "trace_1234567890",
    "client_info": "",
    "init_images": null
  }
}

需要查询返回示例(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
  }
}

请求失败返回示例(status=2)

Response Status:400

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

{
  "request_id": "req_1234567890",
  "trace_id": "trace_1234567890",
  "code": 20003,
  "error_code": 20003,
  "message": "DETECT_NOT_FACE",
  "tips": null,
  "data": {
    "status": 2,
    "result": {
      "ErrorCode": 20003,
      "ErrorMsg": "DETECT_NOT_FACE",
      "Data": null
    },
    "progress": 1,
    "predict_elapsed": 0,
    "create_time": 1718172000000,
    "task_id": "task_1234567890",
    "custom_task_id": "",
    "trace_id": "trace_1234567890",
    "client_info": "",
    "init_images": null
  }
}

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

ErrorCode 状态代码错误信息说明
20001PROCESS_ERROR处理错误
20003DETECT_NOT_FACE人脸缺失
20004MORE_THAN_ONE_FACE人脸数大于 1
20007MISSING_LANDMARK_ARGUMENTS未传入人脸点
20008UNSUITABLE_IMAGE照片不符合规范
20009UNSUPPORT_TYPE不支持的 type
20010DETECT_NOT_FACE检测不到第二张图片的人脸
20011UNSUITABLE_VERTICAL_IMAGE垂直高度不满足
20012UNSUITABLE_HORIZONTAL_IMAGE水平宽度不满足
20013RESOLUTION_TOO_LARGE_ERROR分辨率过大
20014NOT_FOUND查找不到图片
20015PICTURE_OVERRUN_ERROR图片超限
20020DETECT_FACE_OUTOFIMAGE五官缺失
20021DETECT_FACE_PITCHANGLE_BIG非正脸,点头或俯仰角过大
20022DETECT_FACE_YAWANGLE_BIG非正脸,摇头或旋转角过大
20023DETECT_FACE_LOWAREA脸部占比小、像素低
21001LOAD_MODEL_ERROR加载模型失败
21002HAIR_MASK_LOSS头发 mask 缺失
21003FACE_NUM_ERROR人脸个数错误
21004AR_PARSE_FAULTAR 中 plist 解析错误
21005AR_EEEOR_COUNTAR 人脸错误
21006AR_FACE_OUTAR 超过人脸范围
21007JSON_ERRORJSON 内容错误
21008BACKGROUND_IMAGE_LOSS背景图片缺失
21009BODY_MASK_LOSSbody mask 缺失
21010FACE_ANGLE_ERROR人脸角度错误
21011SKIN_MASK_LOSSskin mask 缺失
21012BODY_INFO_LOSS骨骼点或者外轮廓点缺失
21013RECT_OUT_IMAGE超过图片范围
30001GEN_ERROR生成错误

通用的错误代码与信息

详见 API 错误码

SDK 调用示例

以下示例均对最终发送的完整 JSON body 进行签名;实际发送的 body 恰好包含 tasktask_typeinit_imagesparamssync_timeout 五个顶层字段。

Python

import json
import requests
from sign_sdk import sign

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": {"ir_mode": 3}}
payload = {
    "task": "/v1/High_Definition_V3/466658",
    "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)
signed_request = sign.Signer(key, secret).sign(url, method, headers, body)
response = requests.Session().send(signed_request)
print(response.status_code, response.text)

Go

package main

import (
    "fmt"
    "io"
    "net/http"
    "github.com/mtlab/api/signer"
)

func main() {
    signObj := signer.NewSigner("your_api_key", "your_api_secret")
    url := "https://openapi.meitu.com/api/v1/sdk/sync/push"
    headers := make(http.Header)
    headers.Set(signer.HeaderHost, "openapi.meitu.com")
    headers.Set("Content-Type", "application/json")
    body := `{
  "task": "/v1/High_Definition_V3/466658",
  "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\":{\"ir_mode\":3}}",
  "sync_timeout": 30
}`
    req, err := signObj.Sign(url, http.MethodPost, headers, body)
    if err != nil { panic(err) }
    resp, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer resp.Body.Close()
    responseBody, err := io.ReadAll(resp.Body)
    if err != nil { panic(err) }
    fmt.Println(resp.StatusCode, string(responseBody))
}

PHP

<?php
require 'signer.php';

$signer = new Signer('your_api_key', 'your_api_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' => ['ir_mode' => 3],
]);
$body = json_encode([
    'task' => '/v1/High_Definition_V3/466658',
    '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);
echo "Status: {$status}\nResponse: {$response}\n";
curl_close($curl);
?>

Java

package com.meitu.openai.common;

import java.io.InputStream;
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";
        Map<String, String> headers = new HashMap<>();
        headers.put("Content-Type", "application/json");
        headers.put(Signer.HeaderHost, "openapi.meitu.com");
        String body = "{\n" +
                "  \"task\":\"/v1/High_Definition_V3/466658\",\n" +
                "  \"task_type\":\"formula\",\n" +
                "  \"init_images\":[{\"url\":\"https://example.com/input.jpg\",\"profile\":{\"media_profiles\":{\"media_data_type\":\"url\"},\"version\":\"v1\"}}],\n" +
                "  \"params\":\"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"ir_mode\\\":3}}\",\n" +
                "  \"sync_timeout\":30\n" +
                "}";
        Map<String, String> signedHeaders = signer.sign(url, "POST", headers, body);
        HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
        connection.setRequestMethod("POST");
        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();
        System.out.println("Response: " + status + " " + new String(stream.readAllBytes(), StandardCharsets.UTF_8));
    }
}