Background Remover API v1.0.0

This is a public version of the Background Remover API

#

Security definitions

You can authenticate using one of the following methods:

  • An Api-Key header. For example, Api-Key: YOUR_API_KEY.
  • A token query parameter. For example, if you want to make a request to a resource with URL /endpoint, you can specify your key as /endpoint?token=YOUR_API_KEY

Make sure that each request you perform includes your API key in one of the specified formats. Otherwise, the request will fail.

#

Get processed images


GET https://api-bgremover.icons8.com/api/v1/process_images?token=YOUR_API_KEY

#

Parameters

page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


#

Responses

200 - Get processed images
#

Body

total optional integer


images optional array of object


id optional string


filename optional string


source optional object


width optional integer


height optional integer


type optional string


url optional string



processed optional object


width optional integer


height optional integer


type optional string


url optional string



status optional integer


statusName optional string



#

Image upload for process


POST https://api-bgremover.icons8.com/api/v1/process_image?token=YOUR_API_KEY

#

Parameters

image required file


#

Responses

201 - Image upload for process
#

Body

id optional string


filename optional string


source optional object


width optional integer


height optional integer


type optional string


url optional string



processed optional object


width optional integer


height optional integer


type optional string


url optional string



status optional integer


statusName optional string


#

Image upload for process


GET https://api-bgremover.icons8.com/api/v1/process_image?image_url=example123&token=YOUR_API_KEY

#

Parameters

image_url required string


#

Responses

200 - Image upload for process
#

Body

id optional string


filename optional string


source optional object


width optional integer


height optional integer


type optional string


url optional string



processed optional object


width optional integer


height optional integer


type optional string


url optional string



status optional integer


statusName optional string


#

Get processed image


GET https://api-bgremover.icons8.com/api/v1/process_image/{id}?token=YOUR_API_KEY

#

Parameters

id required string


#

Responses

200 - Get processed image
#

Body

id optional string


filename optional string


source optional object


width optional integer


height optional integer


type optional string


url optional string



processed optional object


width optional integer


height optional integer


type optional string


url optional string



status optional integer


statusName optional string