Skip to main content
POST
/
image_editing
/
removebg_mask
Background removal and create mask
curl --request POST \
  --url https://modelslab.com/api/v6/image_editing/removebg_mask \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "image": "<string>",
  "alpha_matting": false,
  "post_process_mask": false,
  "only_mask": false,
  "inverse_mask": false,
  "seed": 123,
  "base64": false,
  "alpha_matting_foreground_threshold": 240,
  "alpha_matting_background_threshold": 20,
  "alpha_matting_erode_size": 5,
  "webhook": "<string>",
  "track_id": 123
}
'
{
  "status": "success",
  "generationTime": 123,
  "id": 123,
  "output": [
    "<string>"
  ],
  "proxy_links": [
    "<string>"
  ],
  "meta": {}
}

​
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
--request POST 'https://modelslab.com/api/v6/image_editing/removebg_mask' \
If you want only mask as a output then set the parameter only_mask:true

​
Body

json
{    
    "key":"",    
    "seed":12345,    
    "image":"https://assets.modelslab.com/generations/31d4567d-b60a-4d09-9650-987fc0aae2cf",    
    "post_process_mask": false,    
    "only_mask": false,    
    "alpha_matting":false,    
    "webhook": null,    
    "track_id": null  
}

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

​
proxy_links
string<uri>[]

Array of proxy image URLs

​
meta
object

Metadata about the generation process