Remove Image Background
Remove the background from an image.
In the playground, ensure at least one field is set to avoid sending a request with an empty body and content-type: application/json, as this is not permitted by the API.
Description
This endpoint allows you to remove the background from an image. Removing the background from an image can be useful for various purposes, such as creating a transparent background or isolating the subject of the image.
The background removal process works by segmenting the image into foreground and background regions. The API uses advanced machine learning algorithms to detect and remove the background from the image, leaving only the foreground subject.
At the moment, removing the background from an image counts as two image processing operations
The output of the background removal process is an image with a transparent background in PNG format. You can use the Convert Image endpoint to convert the image to WebP or JPEG format if needed.
Remove background from a cat image
Request Parameters
The request path should contain the following parameters:
The ID of the image to remove the background.
Request Body
The request body should contain a JSON object with the following fields:
The name of the image to identify it on the dashboard.
Response
The API will return the updated Image object in the response body.
The unique identifier of the image. This identifier is used to reference the image in subsequent requests.
The name of the image. This name is provided when uploading the image and is the way the image is identified in your account. It is not unique, in fact, each transformation you make to an image will create a new image with the same name.
The public URL of the image. By default, this URL is not available and will be null.
You can make the image public by using the publish endpoint.
Once the image is public, the URL will be updated with the public URL.
The width of the image in pixels.
The height of the image in pixels.
The format of the image. The format can be one of the following: jpeg, png, webp.
The estimated size of the image in bytes. The size is an estimate and may not be exact since images can be compressed or optimized depending on the format and quality settings used during processing.
The date and time when the image was created. The date and time are in ISO 8601 format.