Products

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



#

Parameters

page optional integer default 1

Page number


perPage optional integer default 10

Number of results per page. Max: 100


#

Responses

200 - Response
#

Body

body optional


#

Image upload for process



#

Parameters

image_url required string

http(s) URL of a jpeg, png or webp image


result_type optional string default image one of image​alpha​


#

Responses

200 - Response
#

Body

body optional


#

Image upload for process



#

Parameters

image required file


result_type optional string default image one of image​alpha​


#

Responses

201 - Response
#

Body

body optional


#

Get processed image



#

Parameters

id required string


#

Responses

200 - Response
#

Body

body optional


#

Delete processed image



#

Parameters

id required string


#

Responses

200 - Response
#

Body

body optional