1.接口说明
自动去水印 / 图像修复 API:对输入图片中指定区域进行自动修复,可用于去除水印、马赛克、遮挡物或其他损坏区域,输出修复完成后的图片。
1.1 主要功能
- 自动图像修复:
- 自动识别并填补缺损区域,生成自然连贯的纹理和背景。
- 去水印 / 去遮挡:
- 支持去除图片中的 LOGO、水印、文字或遮挡块。
- 支持图片复用:
- 同一图片可通过
image_id多次请求,无需重复上传。
1.2 接入场景
商品图优化、老照片修复、图片清理、营销素材去水印、内容编辑等。
2.请求信息
2.1 请求地址(URL)
POST https://api.shiliuai.com/api/auto_inpaint/v1
2.2 请求方式
POST
2.3 请求头(header)
| 参数 | 类型 | 说明 |
|---|---|---|
| Content-Type | string | application/json |
| APIKEY | string | 您的 API KEY |
2.4 请求体(body)
| 参数 | 是否必填 | 类型 | 说明 |
|---|---|---|---|
| image_base64 | 必须填写其中之一 | string | base64编码的图片文件,必须提供image_base64或image_id其中一个, 图片文件要小于20M,图片的长边不能超过4096像素 |
| image_id | string | 图片id,对于已经请求过的图片,可以使用id而无需再上传image_base64 |
3.返回信息
3.1 返回类型
JSON
3.2 返回字段说明
| 参数 | 说明 |
|---|---|
| code | 错误码 |
| msg | 错误信息(英文) |
| msg_cn | 错误信息(中文) |
| result_base64 | 修复后的图片的base64编码,jpg格式,(当code==0时会有该返回值) |
| image_id | 图片id,(当code==0时会有该返回值) |
3.3 返回示例
{
"code": 0,
"msg": "OK",
"msg_cn": "成功",
"result_base64": "/9j/4AAQSkZJRgABAQAAAQABAAD...",
"image_id": "b6a0f7d0b2f54d0ea3..."
}
// 失败示例
{
"code": 4,
"msg": "Invalid parameter: image_base64 or image_id is required",
"msg_cn": "参数错误:image_base64 或 image_id 必须填写其中之一"
}
3.4 错误码说明
| 错误码 | 说明 |
|---|---|
| 0 | 成功 |
| 1 | 图片错误 |
| 2 | 处理错误 |
| 3 | 服务器繁忙 |
| 4 | 参数错误,具体错误请查看 msg 或 msg_cn |
| 5 | 未知错误 |
| 101 | API-KEY 不正确 |
| 102 | 未知用户 |
| 103 | 积分已用完 |
| 104 | 扣除积分失败 |
4.示例代码
4.1 Python 示例
# -*- coding: utf-8 -*-
import requests
import base64
import cv2
import json
import numpy as np
api_key = '******' # 你的API KEY
image_path = '...' # 图片路径
"""
用 image_base64 请求
"""
with open(image_path, 'rb') as fp:
image_base64 = base64.b64encode(fp.read()).decode('utf8')
url = 'https://api.shiliuai.com/api/auto_inpaint/v1'
headers = {'APIKEY': api_key, "Content-Type": "application/json"}
data = {
"image_base64": image_base64
}
response = requests.post(url=url, headers=headers, json=data)
response = json.loads(response.content)
"""
成功:{'code': 0, 'msg': 'OK', 'msg_cn': '成功', 'result_base64': result_base64, 'image_id': image_id}
or
失败:{'code': error_code, 'msg': error_msg, 'msg_cn': 错误信息}
"""
image_id = response['image_id']
result_base64 = response['result_base64']
file_bytes = base64.b64decode(result_base64)
f = open('result.jpg', 'wb')
f.write(file_bytes)
f.close()
image = np.asarray(bytearray(file_bytes), dtype=np.uint8)
image = cv2.imdecode(image, cv2.IMREAD_UNCHANGED)
cv2.imshow('result', image)
cv2.waitKey(0)
"""
第二次用 image_id 请求
"""
data = {
"image_id": image_id
}
response = requests.post(url=url, headers=headers, json=data)
4.2 PHP 示例
$url = "https://api.shiliuai.com/api/auto_inpaint/v1"; $method = "POST"; $apikey = "******"; $header = array(); array_push($header, "APIKEY:" . $apikey); array_push($header, "Content-Type:application/json"); $image_path = "..."; $handle = fopen($image_path, "r"); $image = fread($handle, filesize($image_path)); fclose($handle); $image_base64 = base64_encode($image); $data = array( "image_base64"=> $image_base64 ); $post_data = json_encode($data); $curl = curl_init(); curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_HTTPHEADER, $header); curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false); $response = curl_exec($curl); var_dump($response);
4.3 C# 示例
using System;
using System.IO;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
class Program
{
static async Task Main(string[] args)
{
string apiKey = "******"; // 你的API KEY
string filePath = "..."; // 图片路径
string url = "https://api.shiliuai.com/api/auto_inpaint/v1";
// 将图片编码为Base64
string photoBase64;
using (var imageStream = File.OpenRead(filePath))
{
byte[] imageBytes = new byte[imageStream.Length];
await imageStream.ReadAsync(imageBytes, 0, (int)imageStream.Length);
photoBase64 = Convert.ToBase64String(imageBytes);
}
// 构造请求数据
var requestData = new
{
image_base64 = photoBase64
};
string jsonData = JsonSerializer.Serialize(requestData);
using (HttpClient client = new HttpClient())
{
client.DefaultRequestHeaders.Add("APIKEY", apiKey);
client.DefaultRequestHeaders.Add("Content-Type", "application/json");
try
{
// 发送POST请求
var response = await client.PostAsync(url, new StringContent(jsonData, Encoding.UTF8, "application/json"));
string responseString = await response.Content.ReadAsStringAsync();
// 解析响应
var responseObject = JsonSerializer.Deserialize<JsonElement>(responseString);
int code = responseObject.GetProperty("code").GetInt32();
if (code == 0)
{
string resultBase64 = responseObject.GetProperty("result_base64").GetString();
// 将Base64转换为图片并保存
byte[] fileBytes = Convert.FromBase64String(resultBase64);
File.WriteAllBytes("result.jpg", fileBytes);
Console.WriteLine("Image processing succeeded, saved as result.jpg");
}
else
{
string errorMsg = responseObject.GetProperty("msg_cn").GetString();
Console.WriteLine($"Error: {errorMsg}");
}
}
catch (Exception ex)
{
Console.WriteLine($"Exception: {ex.Message}");
}
}
}
}