API参考
背景去除

图片背景去除

Action RemoveBackground

简介

此接口主要用于去除背景,也可以用于获取主体内容的蒙版。

请求

参数名类型描述信息必填
ActionString对应的 API 指令名称
PublicKeyString用户公钥,可从 PICPIK用户中心 (opens in a new tab) 获取
SignatureString根据公钥及 API 指令生成的用户签名,参见 签名算法
request_uuidString请求uuid,采用uuid生成方式随机生成,可用于管理您业务和客户的请求
参数名类型描述信息必填
RawImageString需要去除背景的图片,以Base64编码
Box[]int图片实体的边界,需要传递4个数字,分别为左上角x坐标,左上角y坐标,右下角x坐标,右下角y坐标,当此参数空时,则代表图片自动识别裁剪
ErodeSizeInt主体边缘像素模糊区域(0~40),默认值: 15
ForegroundThresholdInt前景的阈值(0~255),默认值: 240
BackgroundThresholdInt背景的阈值(0~255),默认值: 15
HairOptimizationString毛发提取优化,参考值: auto、on、off,默认值: auto
OnlyMaskBool是否只返回蒙版图片,默认值: false

请求示例

{
	"Action": "RemoveBackground",
	"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
	"Signature": "2e3ded4d95337e8e0e76c05f056ff958eb98f062",
	"request_uuid": "15ba36f2-2d69-40bd-9e0c-3e73f0f5acd0",
	"Box": [
		180,
		264,
		510,
		642
	],
	"ErodeSize": 15,
	"ForegroundThreshold": 240,
	"BackgroundThreshold": 15,
	"HairOptimization": "auto",
    "OnlyMask": false,
	"RawImage": "data:image/jpeg;base64,xxx"
}

响应

字段名类型描述信息必填
RetCodeInt返回状态码,为 0 则为成功返回,非 0 为失败
ActionString操作指令名称
MessageString返回错误消息,当 RetCode 非 0 时提供详细的描述信息
request_uuidString返回请求时填写的uuid
参数名类型描述信息必填
TaskUIDString任务UID,用于查询任务详情与获取结果

响应示例

{
	"Action": "RemoveBackground",
	"RetCode": 0,
	"Message": "",
	"request_uuid": "8482d350-04f9-421b-817b-1d98b3a4dcfa",
	"TaskUID": "cktlm6lrh4xxx8ng9nf0"
}