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
}
'
import requests

url = "https://modelslab.com/api/v6/image_editing/removebg_mask"

payload = {
"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
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};

fetch('https://modelslab.com/api/v6/image_editing/removebg_mask', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://modelslab.com/api/v6/image_editing/removebg_mask",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://modelslab.com/api/v6/image_editing/removebg_mask"

payload := strings.NewReader("{\n \"key\": \"<string>\",\n \"image\": \"<string>\",\n \"alpha_matting\": false,\n \"post_process_mask\": false,\n \"only_mask\": false,\n \"inverse_mask\": false,\n \"seed\": 123,\n \"base64\": false,\n \"alpha_matting_foreground_threshold\": 240,\n \"alpha_matting_background_threshold\": 20,\n \"alpha_matting_erode_size\": 5,\n \"webhook\": \"<string>\",\n \"track_id\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://modelslab.com/api/v6/image_editing/removebg_mask")
.header("Content-Type", "application/json")
.body("{\n \"key\": \"<string>\",\n \"image\": \"<string>\",\n \"alpha_matting\": false,\n \"post_process_mask\": false,\n \"only_mask\": false,\n \"inverse_mask\": false,\n \"seed\": 123,\n \"base64\": false,\n \"alpha_matting_foreground_threshold\": 240,\n \"alpha_matting_background_threshold\": 20,\n \"alpha_matting_erode_size\": 5,\n \"webhook\": \"<string>\",\n \"track_id\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://modelslab.com/api/v6/image_editing/removebg_mask")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"key\": \"<string>\",\n \"image\": \"<string>\",\n \"alpha_matting\": false,\n \"post_process_mask\": false,\n \"only_mask\": false,\n \"inverse_mask\": false,\n \"seed\": 123,\n \"base64\": false,\n \"alpha_matting_foreground_threshold\": 240,\n \"alpha_matting_background_threshold\": 20,\n \"alpha_matting_erode_size\": 5,\n \"webhook\": \"<string>\",\n \"track_id\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "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.ai/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

Array of proxy image URLs

meta
object

Metadata about the generation process