AI超清V1

描述

本接口用于在云端处理图片超清请求。

图片要求

支持 JPG、JPEG、BMP 格式。

调用 URL

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

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

请求体恰好包含以下五个顶层字段:

是否必选参数名类型参数说明
必选paramsstring推理参数(JSON 字符串)
必选init_imagesobject[]图片文件列表
必选taskstring固定 /v1/Ultra_High_Definition/466657
必选task_typestring固定 formula
可选sync_timeoutint默认 30-1 表示不等待。同步等待超时后返回状态 9,需使用查询接口获取结果

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

是否必选参数名类型参数说明
必选urlstring图片 URL 或 base64
可选profileobject多媒体参数

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

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

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

是否必选参数名类型参数说明
可选media_data_typestring默认 urlurl 表示通过 URL 传入图片,jpg 表示传入 JPG 图片的 base64

params 推理参数是 JSON 字符串,其反序列化后的结构说明如下

是否必选字段类型说明
可选rsp_media_typestring默认 urlurl 表示结果图片以 URL 返回,jpg 表示结果图片以 JPG base64 返回
必选parameterobject超清算法参数对象

parameter 算法参数详情

是否必选参数名类型参数说明
必选style_idint适配风格 ID;从适配风格枚举接口获取
可选sr_numint图片放大倍数,仅支持 24,默认 2。2 倍最大支持原图 2560 × 2560,4 倍最大支持原图 1280 × 1280
可选create_valueint创造力参数,取值范围 0100;不传时使用适配风格配置的默认值
可选hdr_valueintHDR 增强数值,取值范围 0100;不传时使用适配风格配置的默认值
可选resemblance_valueint相似度数值,取值范围 0100;不传时使用适配风格配置的默认值
可选save_photo_formatint默认 1,表示 JPG 编码;2 表示 PNG 编码

输入值示例

以下示例保留源文中的算法参数值;其中 create_valuehdr_valueresemblance_value 的源文示例传 -1,而参数表声明的取值范围为 0100。接入时应以当前适配风格配置和服务端校验规则为准;如需使用默认配置,也可不传这三个可选字段。

{
  "task": "/v1/Ultra_High_Definition/466657",
  "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\":{\"sr_num\":2,\"style_id\":26,\"create_value\":-1,\"hdr_value\":-1,\"resemblance_value\":-1}}",
  "sync_timeout": 30
}

返回值说明

字段类型说明
request_idstring请求标识
trace_idstring链路追踪标识
codeint业务状态码,0 表示请求受理成功
error_codeint错误码,成功时为 0
messagestring业务信息或错误信息
tipsany补充提示,可为 null
dataobject任务状态和算法结果

data 字段说明

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

result 字段说明

字段类型说明
idstring任务 ID
urlsstring[]结果图片列表;rsp_media_type=url 时为图片 URL,rsp_media_type=jpg 时为 JPG base64
parameterobject算法返回信息类型标识;源文定义其 rsp_media_type 字段
media_info_listobject[]算法多媒体结果列表;每项包含图片数据及对应信息

parameter 返回字段说明

字段类型说明
rsp_media_typestring结果媒体类型;url 表示 media_data 为图片 URL,jpg 表示 media_data 为 JPG base64

media_info_list 单个元素的字段说明

字段类型说明
media_datastring结果图片 URL 或经过 base64 编码的多媒体文件数据,取决于 rsp_media_type
media_profilesobject多媒体文件属性信息

media_profiles 返回字段说明

字段类型说明
media_data_typestring结果媒体数据类型;url 表示 URL,jpg 表示 JPG base64

任务失败时,result 还可能包含源文定义的以下字段:

字段类型说明
ErrorCodeint错误代码
ErrorMsgstring错误信息
Datastring/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,
    "msg": "success",
    "result": {
      "id": "task_1234567890",
      "urls": [
        "https://example.com/result.jpg"
      ],
      "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)

data.status9 时,使用查询接口和返回的任务 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,
    "msg": "processing",
    "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": 20001,
  "error_code": 20001,
  "message": "PROCESS_ERROR",
  "tips": null,
  "data": {
    "status": 2,
    "msg": "PROCESS_ERROR",
    "result": {
      "id": "task_1234567890",
      "ErrorCode": 20001,
      "ErrorMsg": "PROCESS_ERROR",
      "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

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": {
            "style_id": 26,
            "sr_num": 2,
        },
    }
    payload = {
        "task": "/v1/Ultra_High_Definition/466657",
        "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/Ultra_High_Definition/466657",
  "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\":{\"style_id\":26,\"sr_num\":2}}",
  "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' => [
        'style_id' => 26,
        'sr_num' => 2,
    ],
]);
$body = json_encode([
    'task' => '/v1/Ultra_High_Definition/466657',
    '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/Ultra_High_Definition/466657\",\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\\\":{\\\"style_id\\\":26,\\\"sr_num\\\":2}}\",\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);
        }
    }
}