人像增强-基础版

描述

本接口用于人像增强请求,具体效果请看以下文档详情。

版本

2.0

图片要求

  • 视频格式:h263、h264、h265、AV1、MPEG4、VP8、VP9。
  • 视频尺寸:144*144 以内 pvg 不支持;硬件编解码最大支持长边 4096,且宽、高必须是偶数。

调用 URL

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

调用方法

POST

Content-Type: application/json

权限

开放平台接口签名

请求参数

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

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

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

profile 属性信息描述

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

media_profiles 媒体属性信息

是否必选参数名类型参数说明
必选media_data_typestringurl 表示 URL;对应媒体类型表示 base64

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

是否必选字段类型说明
可选rsp_media_typestring默认 urljpg 表示 base64
必选parameterobject算法核心参数对象

parameter 算法参数详情

是否必填参数名类型参数说明
可选media_data_typestring图片数据类型:jpg 表示 media_data 为 base64 编码图片(默认);url 表示 media_data 为图片 URL 地址
可选open_degreeint开放程度:1 支持开放;0 不支持(默认)
可选assign_degreeint人像修复程度,范围 [0, 100],默认 80
可选skip_framesint[]跳帧设置:[start, end] 分别表示首尾跳过帧数;[0, 0] 分片但不跳过;None 不分片(默认)
可选sharp_degreeint锐化程度,范围 [0, 10],默认 5
可选save_rateint输出视频码率相对输入的最大倍数;0 表示不限制(默认)
可选sr_ratefloat分辨率放大倍数,默认 1

输入值示例

{
  "task": "/v1/portrait_enhancement_basic/488147",
  "task_type": "formula",
  "init_images": [
    {
      "url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTczOTUxNjQwMA==/5164853f-02af-4ce9-6c1d-fc5a68c247cd.mp4",
      "profile": {
        "media_profiles": {
          "media_data_type": "url"
        },
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"media_data_type\":\"url\",\"open_degree\":0,\"assign_degree\":80,\"sharp_degree\":5,\"sr_rate\":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 成功
resultobject算法结果
progressnumber任务进度
predict_elapsedint预计耗时,毫秒
create_timeint64创建时间戳,毫秒
task_idstring任务 ID
custom_task_idstring客户自定义任务 ID
trace_idstring链路追踪标识
client_infostring客户端信息
init_imagesobject[]/null输入媒体回显

result 中单个元素的字段说明

字段类型参数说明
idString任务唯一标识
urlsString[]输出媒体 URL 列表
imagesString[]输出媒体(兼容字段)
msgString返回信息
msg_idString消息 ID
parametersObject输出参数信息
dataObject详细处理结果
media_info_listArray媒体信息列表
mtlab_resObject底层服务返回信息

result.parameters 字段说明

字段类型参数说明
rsp_media_typeString返回媒体类型,如 url
versionString算法版本信息

result.data 字段说明

字段类型参数说明
durationObject各阶段耗时
error_codeNumber错误码
error_msgString错误信息
extraObject扩展信息
media_info_listArray媒体信息列表
msg_idString消息 ID
parameterObject参数信息(同 parameters)

duration 字段说明

字段类型参数说明
alg_process_timeNumber算法处理耗时(毫秒)
created_timestampNumber创建时间(秒级时间戳)
pull_timestampNumber拉取时间
repost_timeNumber重试时间
upload_timeNumber上传耗时
waiting_timeNumber排队耗时

extra 字段说明

字段类型参数说明
algo_msgObject算法内部信息
sale_pathString接口路径
trans_metaObject转码信息

algo_msg 字段说明

字段类型参数说明
alg_timeFloat算法执行时间(秒)

trans_meta 字段说明 req_meta(输入信息)

字段类型参数说明
durationFloat输入媒体时长
media_typeString媒体类型

rsp_meta(输出信息)

字段类型参数说明
data_rateFloat码率
durationNumber时长
frame_numNumber帧数
frame_rateNumber帧率
heightNumber高度
widthNumber宽度
resolutionString分辨率(如 480P)
sizeNumber文件大小(字节)
media_typeString媒体类型

media_info_list 字段说明

字段类型参数说明
media_dataString媒体 URL
media_extraObject扩展信息
media_profilesObject媒体属性

media_profiles 字段说明

字段类型参数说明
media_data_fpsNumber帧率
media_data_heightNumber高度
media_data_widthNumber宽度
media_data_sizeNumber文件大小
media_data_typeString媒体类型(如 url

mtlab_res 字段说明

字段类型参数说明
ErrorCodeNumber错误码
ErrorMsgString错误信息
error_codeNumber错误码(兼容字段)
error_msgString错误信息(兼容字段)
media_info_listArray媒体信息
msg_idString消息 ID
parameterObject参数信息

返回值示例

请求成功返回示例

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": 10,
    "result": {
      "id": "t_mt1a3i5n7b3567e106-xxxx-428a-9fce-3b91591f3b8d",
      "urls": [
        "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/b4960953-0cd6-4188-7949-f334bbcc98d7.mp4"
      ],
      "parameters": {
        "rsp_media_type": "url",
        "version": "HDVideo version: 2.9.1 - 更新parsing trt加速"
      },
      "data": {
        "duration": {
          "alg_process_time": 2756,
          "created_timestamp": 1773739299,
          "pull_timestamp": 1773739300,
          "repost_time": 0,
          "upload_time": 72,
          "waiting_time": 1289
        },
        "error_code": 0,
        "error_msg": "success",
        "extra": {
          "algo_msg": {
            "alg_time": 2.53835129737854
          },
          "sale_path": "/v2/hdvideo_async",
          "trans_meta": {
            "req_meta": [
              {
                "duration": 2222.222,
                "media_type": "video"
              }
            ],
            "rsp_meta": [
              {
                "data_rate": 3448.156568771866,
                "duration": 2222,
                "frame_num": 40,
                "frame_rate": 18,
                "height": 512,
                "media_type": "video",
                "resolution": "480P",
                "size": 996492,
                "width": 512
              }
            ]
          }
        },
        "media_info_list": [
          {
            "media_data": "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/b4960953-0cd6-4188-7949-f334bbcc98d7.mp4",
            "media_extra": null,
            "media_profiles": {
              "media_data_fps": 18,
              "media_data_height": 512,
              "media_data_size": 996492,
              "media_data_type": "url",
              "media_data_width": 512
            }
          }
        ],
        "msg_id": "b764d092-xxxx-40d0-4128-r0094612aa68",
        "parameter": {
          "rsp_media_type": "url",
          "version": "HDVideo version: 2.9.1 - 更新parsing trt加速"
        }
      },
      "msg": "success",
      "msg_id": "b764d092-xxxx-40d0-4128-r0094612aa68",
      "images": [
        "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/b4960953-0cd6-4188-7949-f334bbcc98d7.mp4"
      ],
      "mtlab_res": {
        "ErrorCode": 0,
        "ErrorMsg": "",
        "error_code": 0,
        "error_msg": "",
        "media_info_list": null,
        "msg_id": "b764d092-xxxx-40d0-4128-r0094612aa68",
        "parameter": null
      },
      "media_info_list": [
        {
          "media_data": "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/b4960953-0cd6-4188-7949-f334bbcc98d7.mp4",
          "media_extra": null,
          "media_profiles": {
            "media_data_fps": 18,
            "media_data_height": 512,
            "media_data_size": 996492,
            "media_data_type": "url",
            "media_data_width": 512
          }
        }
      ]
    },
    "progress": 1,
    "predict_elapsed": 10000,
    "create_time": 1773739299799,
    "task_id": "t_mt1a3i5n7b3567e106-xxxx-428a-9fce-3b91591f3b8d",
    "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_mt1a3i5n7b3567e106-xxxx-428a-9fce-3b91591f3b8d"
    },
    "progress": 0,
    "predict_elapsed": 10000,
    "create_time": 1773739299799,
    "task_id": "t_mt1a3i5n7b3567e106-xxxx-428a-9fce-3b91591f3b8d",
    "custom_task_id": "",
    "trace_id": "9c2d79a5-xxxx-47db-8f2c-a77a91112006",
    "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": 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": {
            "media_data_type": "url",
            "open_degree": 0,
            "assign_degree": 80,
            "sharp_degree": 5,
            "sr_rate": 1,
        },
    }
    payload = {
        "task": "/v1/portrait_enhancement_basic/488147",
        "task_type": "formula",
        "init_images": [
            {
                "url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTczOTUxNjQwMA==/5164853f-02af-4ce9-6c1d-fc5a68c247cd.mp4",
                "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/portrait_enhancement_basic/488147",
  "task_type": "formula",
  "init_images": [{
    "url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTczOTUxNjQwMA==/5164853f-02af-4ce9-6c1d-fc5a68c247cd.mp4",
    "profile": {
      "media_profiles": {"media_data_type": "url"},
      "version": "v1"
    }
  }],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"media_data_type\":\"url\",\"open_degree\":0,\"assign_degree\":80,\"sharp_degree\":5,\"sr_rate\":1}}",
  "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' => [
        'media_data_type' => 'url',
        'open_degree' => 0,
        'assign_degree' => 80,
        'sharp_degree' => 5,
        'sr_rate' => 1,
    ],
]);

$body = json_encode([
    'task' => '/v1/portrait_enhancement_basic/488147',
    'task_type' => 'formula',
    'init_images' => [
        [
            'url' => 'https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTczOTUxNjQwMA==/5164853f-02af-4ce9-6c1d-fc5a68c247cd.mp4',
            '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/portrait_enhancement_basic/488147\",\n" +
                "  \"task_type\": \"formula\",\n" +
                "  \"init_images\": [{\n" +
                "    \"url\": \"https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTczOTUxNjQwMA==/5164853f-02af-4ce9-6c1d-fc5a68c247cd.mp4\",\n" +
                "    \"profile\": {\n" +
                "      \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
                "      \"version\": \"v1\"\n" +
                "    }\n" +
                "  }],\n" +
                "  \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"media_data_type\\\":\\\"url\\\",\\\"open_degree\\\":0,\\\"assign_degree\\\":80,\\\"sharp_degree\\\":5,\\\"sr_rate\\\":1}}\",\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);
        }
    }
}