PixPro API 官方文档

功能说明：

局部消除接口通过图像 mask 指定需要消除的人、物、文字等区域，在选定区域对图像内容进行消除与重绘补全。

参数详细说明：

file：输入图像Base64 数据，与 file_url 2选1，必须提供1个，如果都提供以file为准。当传递file时请勿携带base64头。

file_url：输入图像URL，同上描述。

mask_file：需要消除区域Mask图像Base64 数据，为单通道灰度图，待消除部分呈白色区域，原图保持部分呈黑色，Mask 分辨率需要和输入原图保持一致，与 mask_file_url 2选1，必须提供1个，如果都提供以mask_file为准。当传递mask_file时请勿携带base64头。

mask_file_url：需要消除区域Mask图像URL，同上描述。

参数限制：

输入图像格式支持：jpg、jpeg、png

输入图像最小限制：单边分辨率大于500px

输入图像最大限制：单边分辨率小于5000px

输入图像大小：选择file时为4.5Mb、选择file_url时为6Mb （Mask图像大小限制相同）

请求参数

Query 参数

action

string

固定值

必需

示例值:

LocalizedImageRemoval

Header 参数

token

string

必需

从"控制台">"我的密钥"中获取

Body 参数multipart/form-data

file

string

可选

图像Base64数据（请勿传递Base64编码头，例如data:image/png...）

示例值:

/9j/4AAQSkZJRgABAQAASABIAAD/2wBDAAcF...

file_url

string

可选

图像URL完整地址（需包含http://或https://）

示例值:

https://pixpro.cc/example.jpg

mask_file

string

可选

需要消除的区域Mask图像Base64数据（请勿传递Base64编码头，例如data:image/png...）

示例值:

/9j/4AAQSkZJRgABAQAASABIAAD/2wBDAAcF.....

mask_file_url

string

可选

需要消除的区域Mask图像URL完整地址（需包含http://或https://）

示例值:

https://pixpro.cc/mask.png

result_format

enum<integer>

必需

返回图像格式：1 代表返回jpeg格式、2 代表返回png格式

枚举值:

示例值:

return_url

enum<integer>

必需

返回图像方式：1 代表返回URL地址（URL有效期为30分钟）、0 代表返回Base64数据（默认0）

枚举值:

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

msg

string

响应说明

必需

data

object

响应数据

必需

image

string

图像

必需

return_url为1时返回图像URL，为0时返回Base64编码后的图像数据

requestID

string

请求ID

必需

示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "image": "http://xxx/uploads/EnhanceImageResolution/20250109/1736410553_9ceca654662a44882e28.jpg"
    },
    "requestID": "8b3d37f6-e738-4994-9159-88b5b1994ae2"
}

🟢200参数无效（code: 604）

🟢200执行失败（code: 605）

🟢200请求无效（code: 608）

🟢200系统内部错误（code: 901）

AI 橡皮擦

请求参数

示例代码

返回响应