Skip to main content
POST
Background removal and create mask

Remove Background Mask

removebg-createmask endpoint result

Request

Make a POST request to below endpoint and pass the required parameters as a request body to the endpoint.
curl
If you want only mask as a output then set the parameter only_mask:true

Body

json

Body

application/json
key
string
required

Your API Key used for request authorization

image
string
required

Link or valid base64 data for the image

alpha_matting
boolean
default:false

Whether to perform alpha matting

post_process_mask
boolean
default:false

Whether to post-process the mask image

only_mask
boolean
default:false

Whether to return only the mask image

inverse_mask
boolean
default:false

This will inverse the generated mask

seed
integer

Seed for reproducible results

base64
boolean
default:false

Get response as base64 string

alpha_matting_foreground_threshold
integer
default:240
Required range: 0 <= x <= 240
alpha_matting_background_threshold
integer
default:20
Required range: 0 <= x <= 20
alpha_matting_erode_size
integer
default:5
Required range: 0 <= x <= 5
webhook
string<uri>

URL to receive POST API call when complete

track_id
integer

ID for webhook identification

Response

200 - application/json

Background removal response

status
enum<string>
Available options:
success
generationTime
number

Time taken to generate the image in seconds

id
integer

Unique identifier for the generation request

output
string<uri>[]

Array of generated image URLs

Array of proxy image URLs

meta
object

Metadata about the generation process