API Reference
Remove Backgrounds in Batch

Remove Backgrounds in Batch

Action RemoveBackgroundsInBatch

Introduction

This interface is used to remove backgrounds in batches

Request

Parameter NameTypeDescriptionRequired
ActionStringThe corresponding API command name, the current API is RemoveBackgroundsInBatch
PublicKeyStringUser's public key, can be obtained from User Center (opens in a new tab)
SignatureStringUser signature generated based on public key and API command, see Signature
request_uuidStringRequest UUID, randomly generated using UUID generation method
RawImages[]StringBase64 array of pictures that need to remove the background
ErodeSizeIntSubject edge pixel blur area (0~40), default: 15
ForegroundThresholdIntForeground threshold (0~255), default: 240
BackgroundThresholdIntBackground threshold (0~255),default: 15
HairOptimizationStringImage Hair Optimization, reference value: auto、on、off,default: auto
OnlyMaskBoolonly return masked images? default: false

Request Example

{
	"Action": "RemoveBackgroundsInBatch",
	"PublicKey": "ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
	"Signature": "2e3ded4d95337e8e0e76c05f056ff958eb98f062",
	"request_uuid": "15ba36f2-2d69-40bd-9e0c-3e73f0f5acd0",
	"ErodeSize": 15,
	"ForegroundThreshold": 240,
	"BackgroundThreshold": 15,
	"HairOptimization": "auto",
    "OnlyMask": false,
	"RawImages": ["data:image/jpeg;base64,xxx","data:image/jpeg;base64,yyyy"]
}

Response

Parameter NameTypeDescriptionRequired
RetCodeIntReturn status code, 0 for successful return, non-zero for failure
ActionStringOperation command name
MessageStringReturn error message, provide detailed description when RetCode is non-zero
request_uuidStringReturns the requested uuid
TaskUIDStringTask UID, used to query task details and get results

Response Example

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