局部重绘 pro版
描述
本接口用于发起基于 Mask 的图像编辑任务。支持仅使用 prompt 编辑图片,也支持同时上传 Mask 图片指定编辑区域;任务提交后系统将执行编辑算法,超时任务可通过查询接口获取处理结果。
版本
1.0
图片要求
图片格式:JPG、PNG。第 1 张图片为必选的输入图片,第 2 张图片为可选的 Mask 图片。
调用 URL
正式环境:https://openapi.meitu.com
任务提交接口:https://openapi.meitu.com/api/v1/sdk/sync/push
任务名称(task):/v1/InPainting_pro/484505
任务类型(task_type):formula调用方法
POST
Content-Type: application/json
权限
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | params | string | 算法参数(JSON 字符串) |
| 必选 | init_images | object[] | 多媒体文件列表;第 1 张为输入图片,第 2 张为可选的 Mask 图片 |
| 必选 | task | string | 固定 /v1/InPainting_pro/484505 |
| 必选 | task_type | string | 固定 formula |
| 可选 | sync_timeout | int | 默认 30;-1 表示不等待。同步超时后 status 返回 9,需使用查询接口查询 |
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 算法参数详情
| 是否必选 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 必选 | num_samples | string | 生成图片的张数 |
| 必选 | prompt_pos | string | 编辑 prompt |
输入值示例
仅使用 prompt 进行图像编辑:
{
"task": "/v1/InPainting_pro/484505",
"task_type": "formula",
"init_images": [
{
"url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTc1MjIwMjgwMA==/fbe1aef9-d778-4236-74ec-133cbb7d6ceb.jpeg",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"num_samples\":\"2\",\"prompt_pos\":\"change hairstyle to pink\"}}",
"sync_timeout": 30
}使用 Mask 进行图像编辑:
{
"task": "/v1/InPainting_pro/484505",
"task_type": "formula",
"init_images": [
{
"url": "http://autotest.meitudata.com/file/image_edit_wmask_1.jpg",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
},
{
"url": "http://autotest.meitudata.com/file/image_edit_wmask_1_mask.jpg",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"num_samples\":\"2\",\"prompt_pos\":\"\"}}",
"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 | data 内链路标识 |
| client_info | string | 客户端信息 |
| init_images | object[]/null | 输入媒体回显 |
result 中单个元素的字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 任务 ID |
| parameters | object | 任务结果参数 |
| urls | string[] | 任务结果 URL |
| data | object | 算法处理详情 |
| msg | string | 处理结果信息 |
| msg_id | string | 消息 ID |
| images | string[] | 生成图片 URL |
| mtlab_res | object | 算法服务返回信息 |
| media_info_list | object[] | 生成媒体信息列表 |
返回值示例
请求成功返回示例
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_mt1a3i5n7bc7a42cbd-8def-49ab-9ca0-efa144cd279d",
"urls": [
"https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/8ea5616e-54f8-488a-7e6d-5d6b4a83d0c9.png",
"https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/0c1bf9c3-be73-48e6-7148-6f40e7abb5b7.png"
],
"parameters": {
"rsp_media_type": "url",
"version": "1.0.0"
},
"data": {
"duration": {
"alg_process_time": 26054,
"created_timestamp": 1763984981,
"pull_timestamp": 1763984981,
"repost_time": 0,
"upload_time": 317,
"waiting_time": 27
},
"error_code": 0,
"error_msg": "success",
"extra": {
"algo_msg": {
"alg_time": 25.803189754486084
},
"trans_meta": {
"req_meta": [
{
"media_type": "image"
},
{
"media_type": "image"
}
],
"rsp_meta": [
{
"height": 2227,
"media_type": "image",
"size": 10797.9052734375,
"width": 1655
},
{
"height": 2227,
"media_type": "image",
"size": 10797.9052734375,
"width": 1655
}
]
}
},
"media_info_list": [
{
"media_data": "https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/8ea5616e-54f8-488a-7e6d-5d6b4a83d0c9.png",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
},
{
"media_data": "https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/0c1bf9c3-be73-48e6-7148-6f40e7abb5b7.png",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
}
],
"msg_id": "27a15d54-3c9d-4ce6-7c99-r0090b5dae27",
"parameter": {
"rsp_media_type": "url",
"version": "1.0.0"
}
},
"msg": "success",
"msg_id": "27a15d54-3c9d-4ce6-7c99-r0090b5dae27",
"images": [
"https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/8ea5616e-54f8-488a-7e6d-5d6b4a83d0c9.png",
"https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/0c1bf9c3-be73-48e6-7148-6f40e7abb5b7.png"
],
"mtlab_res": {
"ErrorCode": 0,
"ErrorMsg": "",
"error_code": 0,
"error_msg": "",
"media_info_list": null,
"msg_id": "27a15d54-3c9d-4ce6-7c99-r0090b5dae27",
"parameter": null
},
"media_info_list": [
{
"media_data": "https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/8ea5616e-54f8-488a-7e6d-5d6b4a83d0c9.png",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
},
{
"media_data": "https://oss-open-platform.meitudata.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/0c1bf9c3-be73-48e6-7148-6f40e7abb5b7.png",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
}
]
},
"progress": 1,
"predict_elapsed": 10000,
"create_time": 1763984981264,
"task_id": "t_mt1a3i5n7bc7a42cbd-8def-49ab-9ca0-efa144cd279d",
"custom_task_id": "",
"trace_id": "b916407f-1ce0-40d7-9651-28040b64b8b4",
"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_mt1a3i5n7b3da6d589-46b5-4f66-a0bb-8dd22f2a172e"
},
"progress": 0,
"predict_elapsed": 10000,
"create_time": 1759202368761,
"task_id": "t_mt1a3i5n7b3da6d589-46b5-4f66-a0bb-8dd22f2a172e",
"custom_task_id": "",
"trace_id": "9129a3a2-99c4-46ce-8731-0e100e2fbee7",
"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": "ALGO_MODEL_CRASH",
"tips": null,
"data": {
"status": 2,
"result": {
"id": "t_mt1a3i5n7be8d575cc-2ffb-4e0c-85a8-1824110e31b8",
"code": 20001,
"data": {
"duration": {
"alg_process_time": 0,
"created_timestamp": 1759201989,
"pull_timestamp": 1759201989,
"repost_time": 0,
"upload_time": 0,
"waiting_time": 0
},
"error_code": 20001,
"error_msg": "ALGO_MODEL_CRASH",
"extra": {},
"media_info_list": [],
"msg_id": "c1b09cb2-6e05-4d21-55ab-r007b1f21bec",
"parameter": null
},
"msg": "ALGO_MODEL_CRASH",
"msg_id": "c1b09cb2-6e05-4d21-55ab-r007b1f21bec"
},
"progress": 1,
"predict_elapsed": 10000,
"create_time": 1759201989444,
"task_id": "t_mt1a3i5n7be8d575cc-2ffb-4e0c-85a8-1824110e31b8",
"custom_task_id": "",
"trace_id": "",
"client_info": "",
"init_images": null
}
}当前 API 特有的错误代码与信息
原文错误码表将 20001 标记为 PROCESS_ERROR,失败响应示例中的消息为 ALGO_MODEL_CRASH。
| ErrorCode 状态代码 | 错误信息 | 说明 |
|---|---|---|
| 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": {
"num_samples": "2",
"prompt_pos": "change hairstyle to pink",
},
}
payload = {
"task": "/v1/InPainting_pro/484505",
"task_type": "formula",
"init_images": [
{
"url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTc1MjIwMjgwMA==/fbe1aef9-d778-4236-74ec-133cbb7d6ceb.jpeg",
"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/InPainting_pro/484505",
"task_type": "formula",
"init_images": [{
"url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTc1MjIwMjgwMA==/fbe1aef9-d778-4236-74ec-133cbb7d6ceb.jpeg",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1"
}
}],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"num_samples\":\"2\",\"prompt_pos\":\"change hairstyle to pink\"}}",
"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' => [
'num_samples' => '2',
'prompt_pos' => 'change hairstyle to pink',
],
]);
$body = json_encode([
'task' => '/v1/InPainting_pro/484505',
'task_type' => 'formula',
'init_images' => [
[
'url' => 'https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTc1MjIwMjgwMA==/fbe1aef9-d778-4236-74ec-133cbb7d6ceb.jpeg',
'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/InPainting_pro/484505\",\n" +
" \"task_type\": \"formula\",\n" +
" \"init_images\": [{\n" +
" \"url\": \"https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTc1MjIwMjgwMA==/fbe1aef9-d778-4236-74ec-133cbb7d6ceb.jpeg\",\n" +
" \"profile\": {\n" +
" \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
" \"version\": \"v1\"\n" +
" }\n" +
" }],\n" +
" \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"num_samples\\\":\\\"2\\\",\\\"prompt_pos\\\":\\\"change hairstyle to pink\\\"}}\",\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);
}
}
}