Image Background Removal
Introduction
Background removal is a powerful image processing technique used to isolate subjects from their backgrounds, resulting in images with transparent backgrounds. This capability is essential for enhancing product images, creating professional portraits, or integrating subjects into various design compositions seamlessly.
Request
Our API always accepts an array of objects as input, where each object represents a specific task to be performed. The structure of the object varies depending on the type of the task. For this section, we will focus on the parameters related to the background removal task.
The following JSON snippets shows the basic structure of a request object. All properties are explained in detail in the next section.
-
taskType
-
The type of task to be performed. For this task, the value should be
imageBackgroundRemoval
. -
taskUUID
-
When a task is sent to the API you must include a random UUID v4 string using the
taskUUID
parameter. This string is used to match the async responses to their corresponding tasks.If you send multiple tasks at the same time, the
taskUUID
will help you match the responses to the correct tasks.The
taskUUID
must be unique for each task you send to the API. -
inputImage
-
Specifies the input image to be processed. The image can be specified in one of the following formats:
- An UUID v4 string of a previously uploaded image or a generated image.
- A data URI string representing the image. The data URI must be in the format
data:<mediaType>;base64,
followed by the base64-encoded image. For example:data:image/png;base64,iVBORw0KGgo...
. - A base64 encoded image without the data URI prefix. For example:
iVBORw0KGgo...
. - A URL pointing to the image. The image must be accessible publicly.
Supported formats are: PNG, JPG and WEBP.
-
outputType
-
Specifies the output type in which the image is returned. Supported values are:
dataURI
,URL
, andbase64Data
.base64Data
: The image is returned as a base64-encoded string using theimageBase64Data
parameter in the response object.dataURI
: The image is returned as a data URI string using theimageDataURI
parameter in the response object.URL
: The image is returned as a URL string using theimageURL
parameter in the response object.
-
outputFormat
-
Specifies the format of the output image. Supported formats are:
PNG
,JPG
andWEBP
. -
includeCost
-
If set to
true
, the cost to perform the task will be included in the response object. -
rgba
-
An array representing the
[red, green, blue, alpha]
values that define the color of the removed background. The alpha channel controls transparency. -
postProcessMask
-
Flag indicating whether to post-process the mask. Controls whether the mask should undergo additional post-processing. This step can improve the accuracy and quality of the background removal mask.
-
returnOnlyMask
-
Flag indicating whether to return only the mask. The mask is the opposite of the image background removal.
-
alphaMatting
-
Flag indicating whether to use alpha matting. Alpha matting is a post-processing technique that enhances the quality of the output by refining the edges of the foreground object.
-
alphaMattingForegroundThreshold
-
Threshold value used in alpha matting to distinguish the foreground from the background. Adjusting this parameter affects the sharpness and accuracy of the foreground object edges.
-
alphaMattingBackgroundThreshold
-
Threshold value used in alpha matting to refine the background areas. It influences how aggressively the algorithm removes the background while preserving image details. The higher the value, the more computation is needed and therefore the more expensive the operation is.
-
alphaMattingErodeSize
-
Specifies the size of the erosion operation used in alpha matting. Erosion helps in smoothing the edges of the foreground object for a cleaner removal of the background.
Response
Results will be delivered in the format below.
-
taskType
-
The type of task to be performed. For this task, the value should be
imageBackgroundRemoval
. -
taskUUID
-
The API will return the
taskUUID
you sent in the request. This way you can match the responses to the correct request tasks. -
imageUUID
-
The unique identifier of the image.
-
imageURL
-
If
outputType
is set toURL
, this parameter contains the URL of the image to be downloaded. -
imageBase64Data
-
If
outputType
is set tobase64Data
, this parameter contains the base64-encoded image data. -
imageDataURI
-
If
outputType
is set todataURI
, this parameter contains the data URI of the image. -
cost
-
if
includeCost
is set totrue
, the response will include acost
field for each task object. This field indicates the cost of the request in USD.