Background Removal API

POST Remove the background of an image

{{baseUrl}}/removebg

BODY json

{
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
}

Examples

REQUEST

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/removebg");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}");

CURLcode ret = curl_easy_perform(hnd);

(require '[clj-http.client :as client])

(client/post "{{baseUrl}}/removebg" {:content-type :json
                                                     :form-params {:add_shadow false
                                                                   :bg_color ""
                                                                   :bg_image_url ""
                                                                   :channels ""
                                                                   :crop false
                                                                   :crop_margin ""
                                                                   :format ""
                                                                   :image_file_b64 ""
                                                                   :image_url ""
                                                                   :position ""
                                                                   :roi ""
                                                                   :scale ""
                                                                   :semitransparency false
                                                                   :size ""
                                                                   :type ""
                                                                   :type_level ""}})

require "http/client"

url = "{{baseUrl}}/removebg"
headers = HTTP::Headers{
  "content-type" => "application/json"
}
reqBody = "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}"

response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("{{baseUrl}}/removebg"),
    Content = new StringContent("{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

var client = new RestClient("{{baseUrl}}/removebg");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);

package main

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

func main() {

	url := "{{baseUrl}}/removebg"

	payload := strings.NewReader("{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\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(res)
	fmt.Println(string(body))

}

POST /baseUrl/removebg HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 303

{
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
}

AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/removebg")
  .setHeader("content-type", "application/json")
  .setBody("{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("{{baseUrl}}/removebg"))
    .header("content-type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}"))
    .build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/removebg")
  .post(body)
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

HttpResponse response = Unirest.post("{{baseUrl}}/removebg")
  .header("content-type", "application/json")
  .body("{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}")
  .asString();

const data = JSON.stringify({
  add_shadow: false,
  bg_color: '',
  bg_image_url: '',
  channels: '',
  crop: false,
  crop_margin: '',
  format: '',
  image_file_b64: '',
  image_url: '',
  position: '',
  roi: '',
  scale: '',
  semitransparency: false,
  size: '',
  type: '',
  type_level: ''
});

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('POST', '{{baseUrl}}/removebg');
xhr.setRequestHeader('content-type', 'application/json');

xhr.send(data);

import axios from 'axios';

const options = {
  method: 'POST',
  url: '{{baseUrl}}/removebg',
  headers: {'content-type': 'application/json'},
  data: {
    add_shadow: false,
    bg_color: '',
    bg_image_url: '',
    channels: '',
    crop: false,
    crop_margin: '',
    format: '',
    image_file_b64: '',
    image_url: '',
    position: '',
    roi: '',
    scale: '',
    semitransparency: false,
    size: '',
    type: '',
    type_level: ''
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = '{{baseUrl}}/removebg';
const options = {
  method: 'POST',
  headers: {'content-type': 'application/json'},
  body: '{"add_shadow":false,"bg_color":"","bg_image_url":"","channels":"","crop":false,"crop_margin":"","format":"","image_file_b64":"","image_url":"","position":"","roi":"","scale":"","semitransparency":false,"size":"","type":"","type_level":""}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const settings = {
  async: true,
  crossDomain: true,
  url: '{{baseUrl}}/removebg',
  method: 'POST',
  headers: {
    'content-type': 'application/json'
  },
  processData: false,
  data: '{\n  "add_shadow": false,\n  "bg_color": "",\n  "bg_image_url": "",\n  "channels": "",\n  "crop": false,\n  "crop_margin": "",\n  "format": "",\n  "image_file_b64": "",\n  "image_url": "",\n  "position": "",\n  "roi": "",\n  "scale": "",\n  "semitransparency": false,\n  "size": "",\n  "type": "",\n  "type_level": ""\n}'
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}")
val request = Request.Builder()
  .url("{{baseUrl}}/removebg")
  .post(body)
  .addHeader("content-type", "application/json")
  .build()

val response = client.newCall(request).execute()

const http = require('https');

const options = {
  method: 'POST',
  hostname: 'example.com',
  port: null,
  path: '/baseUrl/removebg',
  headers: {
    'content-type': 'application/json'
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({
  add_shadow: false,
  bg_color: '',
  bg_image_url: '',
  channels: '',
  crop: false,
  crop_margin: '',
  format: '',
  image_file_b64: '',
  image_url: '',
  position: '',
  roi: '',
  scale: '',
  semitransparency: false,
  size: '',
  type: '',
  type_level: ''
}));
req.end();

const request = require('request');

const options = {
  method: 'POST',
  url: '{{baseUrl}}/removebg',
  headers: {'content-type': 'application/json'},
  body: {
    add_shadow: false,
    bg_color: '',
    bg_image_url: '',
    channels: '',
    crop: false,
    crop_margin: '',
    format: '',
    image_file_b64: '',
    image_url: '',
    position: '',
    roi: '',
    scale: '',
    semitransparency: false,
    size: '',
    type: '',
    type_level: ''
  },
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

const unirest = require('unirest');

const req = unirest('POST', '{{baseUrl}}/removebg');

req.headers({
  'content-type': 'application/json'
});

req.type('json');
req.send({
  add_shadow: false,
  bg_color: '',
  bg_image_url: '',
  channels: '',
  crop: false,
  crop_margin: '',
  format: '',
  image_file_b64: '',
  image_url: '',
  position: '',
  roi: '',
  scale: '',
  semitransparency: false,
  size: '',
  type: '',
  type_level: ''
});

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const axios = require('axios').default;

const options = {
  method: 'POST',
  url: '{{baseUrl}}/removebg',
  headers: {'content-type': 'application/json'},
  data: {
    add_shadow: false,
    bg_color: '',
    bg_image_url: '',
    channels: '',
    crop: false,
    crop_margin: '',
    format: '',
    image_file_b64: '',
    image_url: '',
    position: '',
    roi: '',
    scale: '',
    semitransparency: false,
    size: '',
    type: '',
    type_level: ''
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const fetch = require('node-fetch');

const url = '{{baseUrl}}/removebg';
const options = {
  method: 'POST',
  headers: {'content-type': 'application/json'},
  body: '{"add_shadow":false,"bg_color":"","bg_image_url":"","channels":"","crop":false,"crop_margin":"","format":"","image_file_b64":"","image_url":"","position":"","roi":"","scale":"","semitransparency":false,"size":"","type":"","type_level":""}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

#import 

NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"add_shadow": @NO,
                              @"bg_color": @"",
                              @"bg_image_url": @"",
                              @"channels": @"",
                              @"crop": @NO,
                              @"crop_margin": @"",
                              @"format": @"",
                              @"image_file_b64": @"",
                              @"image_url": @"",
                              @"position": @"",
                              @"roi": @"",
                              @"scale": @"",
                              @"semitransparency": @NO,
                              @"size": @"",
                              @"type": @"",
                              @"type_level": @"" };

NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/removebg"]
                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                   timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                if (error) {
                                                    NSLog(@"%@", error);
                                                } else {
                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
                                                    NSLog(@"%@", httpResponse);
                                                }
                                            }];
[dataTask resume];

open Cohttp_lwt_unix
open Cohttp
open Lwt

let uri = Uri.of_string "{{baseUrl}}/removebg" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}" in

Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
  (* Do stuff with the result *)

 "{{baseUrl}}/removebg",
  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([
    'add_shadow' => null,
    'bg_color' => '',
    'bg_image_url' => '',
    'channels' => '',
    'crop' => null,
    'crop_margin' => '',
    'format' => '',
    'image_file_b64' => '',
    'image_url' => '',
    'position' => '',
    'roi' => '',
    'scale' => '',
    'semitransparency' => null,
    'size' => '',
    'type' => '',
    'type_level' => ''
  ]),
  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;
}

request('POST', '{{baseUrl}}/removebg', [
  'body' => '{
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
}',
  'headers' => [
    'content-type' => 'application/json',
  ],
]);

echo $response->getBody();

setUrl('{{baseUrl}}/removebg');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders([
  'content-type' => 'application/json'
]);

$request->setContentType('application/json');
$request->setBody(json_encode([
  'add_shadow' => null,
  'bg_color' => '',
  'bg_image_url' => '',
  'channels' => '',
  'crop' => null,
  'crop_margin' => '',
  'format' => '',
  'image_file_b64' => '',
  'image_url' => '',
  'position' => '',
  'roi' => '',
  'scale' => '',
  'semitransparency' => null,
  'size' => '',
  'type' => '',
  'type_level' => ''
]));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

append(json_encode([
  'add_shadow' => null,
  'bg_color' => '',
  'bg_image_url' => '',
  'channels' => '',
  'crop' => null,
  'crop_margin' => '',
  'format' => '',
  'image_file_b64' => '',
  'image_url' => '',
  'position' => '',
  'roi' => '',
  'scale' => '',
  'semitransparency' => null,
  'size' => '',
  'type' => '',
  'type_level' => ''
]));
$request->setRequestUrl('{{baseUrl}}/removebg');
$request->setRequestMethod('POST');
$request->setBody($body);

$request->setHeaders([
  'content-type' => 'application/json'
]);

$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/removebg' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
}'

$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/removebg' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
}'

import http.client

conn = http.client.HTTPSConnection("example.com")

payload = "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}"

headers = { 'content-type': "application/json" }

conn.request("POST", "/baseUrl/removebg", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

import requests

url = "{{baseUrl}}/removebg"

payload = {
    "add_shadow": False,
    "bg_color": "",
    "bg_image_url": "",
    "channels": "",
    "crop": False,
    "crop_margin": "",
    "format": "",
    "image_file_b64": "",
    "image_url": "",
    "position": "",
    "roi": "",
    "scale": "",
    "semitransparency": False,
    "size": "",
    "type": "",
    "type_level": ""
}
headers = {"content-type": "application/json"}

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

print(response.json())

library(httr)

url <- "{{baseUrl}}/removebg"

payload <- "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}"

encode <- "json"

response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)

content(response, "text")

require 'uri'
require 'net/http'

url = URI("{{baseUrl}}/removebg")

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  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}"

response = http.request(request)
puts response.read_body

require 'faraday'

conn = Faraday.new(
  url: 'https://example.com',
  headers: {'Content-Type' => 'application/json'}
)

response = conn.post('/baseUrl/removebg') do |req|
  req.body = "{\n  \"add_shadow\": false,\n  \"bg_color\": \"\",\n  \"bg_image_url\": \"\",\n  \"channels\": \"\",\n  \"crop\": false,\n  \"crop_margin\": \"\",\n  \"format\": \"\",\n  \"image_file_b64\": \"\",\n  \"image_url\": \"\",\n  \"position\": \"\",\n  \"roi\": \"\",\n  \"scale\": \"\",\n  \"semitransparency\": false,\n  \"size\": \"\",\n  \"type\": \"\",\n  \"type_level\": \"\"\n}"
end

puts response.status
puts response.body

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "{{baseUrl}}/removebg";

    let payload = json!({
        "add_shadow": false,
        "bg_color": "",
        "bg_image_url": "",
        "channels": "",
        "crop": false,
        "crop_margin": "",
        "format": "",
        "image_file_b64": "",
        "image_url": "",
        "position": "",
        "roi": "",
        "scale": "",
        "semitransparency": false,
        "size": "",
        "type": "",
        "type_level": ""
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("content-type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url {{baseUrl}}/removebg \
  --header 'content-type: application/json' \
  --data '{
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
}'

echo '{
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
}' |  \
  http POST {{baseUrl}}/removebg \
  content-type:application/json

wget --quiet \
  --method POST \
  --header 'content-type: application/json' \
  --body-data '{\n  "add_shadow": false,\n  "bg_color": "",\n  "bg_image_url": "",\n  "channels": "",\n  "crop": false,\n  "crop_margin": "",\n  "format": "",\n  "image_file_b64": "",\n  "image_url": "",\n  "position": "",\n  "roi": "",\n  "scale": "",\n  "semitransparency": false,\n  "size": "",\n  "type": "",\n  "type_level": ""\n}' \
  --output-document \
  - {{baseUrl}}/removebg

import Foundation

let headers = ["content-type": "application/json"]
let parameters = [
  "add_shadow": false,
  "bg_color": "",
  "bg_image_url": "",
  "channels": "",
  "crop": false,
  "crop_margin": "",
  "format": "",
  "image_file_b64": "",
  "image_url": "",
  "position": "",
  "roi": "",
  "scale": "",
  "semitransparency": false,
  "size": "",
  "type": "",
  "type_level": ""
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/removebg")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

RESPONSE HEADERS

Content-Type

application/json

RESPONSE BODY json

{
  "data": {
    "foreground_height": 100,
    "foreground_left": 0,
    "foreground_top": 0,
    "foreground_width": 100,
    "result_b64": "iVBORw0KGgoAAAANSUhEUgAAAIsAAACFC..."
  }
}

RESPONSE HEADERS

Content-Type

image/*

RESPONSE BODY text

(binary image data)

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "failed_bg_download",
      "title": "Failed to download background image from given image_url: https://unsplash.com/"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "failed_image_download",
      "title": "Failed to download image from given image_url: https://unsplash.com/"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "failed_to_read_image",
      "title": "There was an error reading the image."
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "file_too_large",
      "detail": "File exceeds limit of 12MB",
      "title": "File too large"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_bg_color",
      "title": "Invalid bg_color parameter given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_bg_image_url",
      "title": "Invalid bg_image_url: Please provide a valid URL."
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_channels",
      "title": "Invalid value for parameter 'channels'"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_crop_margin",
      "title": "Invalid crop_margin parameter given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_dimensions",
      "detail": "The dimensions of the given image could not be read.",
      "title": "Failed to read image dimensions"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_file_type",
      "detail": "Expected jpg/png, received mp4",
      "title": "Invalid file type"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_format",
      "title": "Invalid format parameter given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_image_url",
      "title": "Invalid image_url: Please provide a valid URL."
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_position",
      "title": "Invalid position parameter given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_roi",
      "title": "Invalid roi parameter given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_scale",
      "title": "Invalid scale parameter given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_semitransparency",
      "title": "Invalid semitransparency parameter given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "invalid_size",
      "title": "Invalid value for parameter 'size'"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "missing_source",
      "detail": "Please provide the source image in the image_url, image_file or image_file_b64 parameter.",
      "title": "No image given"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "multiple_bg_sources",
      "title": "Multiple background sources given: Please provide either the bg_color, the bg_image_url or the bg_image_file parameter."
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "multiple_sources",
      "title": "Multiple image sources given: Please provide either the image_url, image_file or image_file_b64 parameter."
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "resolution_too_high",
      "detail": "Input image has 60 megapixels, maximum supported input resolution is 50 megapixels",
      "title": "Image resolution too high"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "roi_exceeds_bounds",
      "detail": "The given roi parameter defines a region that exceeds the image bounds",
      "title": "ROI exceeds image bounds"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "roi_region_empty",
      "detail": "The given roi parameter defines an empty region",
      "title": "ROI region is empty"
    }
  ]
}

RESPONSE HEADERS

Content-Type

*/*

RESPONSE BODY text

{
  "errors": [
    {
      "code": "unknown_foreground",
      "title": "Could not identify foreground in image. For details and recommendations see https://www.remove.bg/supported-images."
    }
  ]
}

GET Fetch credit balance and free API calls.

{{baseUrl}}/account

Examples

REQUEST

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/account");

CURLcode ret = curl_easy_perform(hnd);

(require '[clj-http.client :as client])

(client/get "{{baseUrl}}/account")

require "http/client"

url = "{{baseUrl}}/account"

response = HTTP::Client.get url
puts response.body

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("{{baseUrl}}/account"),
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

var client = new RestClient("{{baseUrl}}/account");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);

package main

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

func main() {

	url := "{{baseUrl}}/account"

	req, _ := http.NewRequest("GET", url, nil)

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

GET /baseUrl/account HTTP/1.1
Host: example.com

AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/account")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("{{baseUrl}}/account"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("{{baseUrl}}/account")
  .get()
  .build();

Response response = client.newCall(request).execute();

HttpResponse response = Unirest.get("{{baseUrl}}/account")
  .asString();

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('GET', '{{baseUrl}}/account');

xhr.send(data);

import axios from 'axios';

const options = {method: 'GET', url: '{{baseUrl}}/account'};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = '{{baseUrl}}/account';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

const settings = {
  async: true,
  crossDomain: true,
  url: '{{baseUrl}}/account',
  method: 'GET',
  headers: {}
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

val client = OkHttpClient()

val request = Request.Builder()
  .url("{{baseUrl}}/account")
  .get()
  .build()

val response = client.newCall(request).execute()

const http = require('https');

const options = {
  method: 'GET',
  hostname: 'example.com',
  port: null,
  path: '/baseUrl/account',
  headers: {}
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

const request = require('request');

const options = {method: 'GET', url: '{{baseUrl}}/account'};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

const unirest = require('unirest');

const req = unirest('GET', '{{baseUrl}}/account');

req.end(function (res) {
  if (res.error) throw new Error(res.error);

  console.log(res.body);
});

const axios = require('axios').default;

const options = {method: 'GET', url: '{{baseUrl}}/account'};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const fetch = require('node-fetch');

const url = '{{baseUrl}}/account';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

#import 

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/account"]
                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                   timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                if (error) {
                                                    NSLog(@"%@", error);
                                                } else {
                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
                                                    NSLog(@"%@", httpResponse);
                                                }
                                            }];
[dataTask resume];

open Cohttp_lwt_unix
open Cohttp
open Lwt

let uri = Uri.of_string "{{baseUrl}}/account" in

Client.call `GET uri
>>= fun (res, body_stream) ->
  (* Do stuff with the result *)

 "{{baseUrl}}/account",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

request('GET', '{{baseUrl}}/account');

echo $response->getBody();

setUrl('{{baseUrl}}/account');
$request->setMethod(HTTP_METH_GET);

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

setRequestUrl('{{baseUrl}}/account');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();

echo $response->getBody();

$response = Invoke-WebRequest -Uri '{{baseUrl}}/account' -Method GET

$response = Invoke-RestMethod -Uri '{{baseUrl}}/account' -Method GET

import http.client

conn = http.client.HTTPSConnection("example.com")

conn.request("GET", "/baseUrl/account")

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

import requests

url = "{{baseUrl}}/account"

response = requests.get(url)

print(response.json())

library(httr)

url <- "{{baseUrl}}/account"

response <- VERB("GET", url, content_type("application/octet-stream"))

content(response, "text")

require 'uri'
require 'net/http'

url = URI("{{baseUrl}}/account")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

require 'faraday'

conn = Faraday.new(
  url: 'https://example.com',
)

response = conn.get('/baseUrl/account') do |req|
end

puts response.status
puts response.body

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "{{baseUrl}}/account";

    let client = reqwest::Client::new();
    let response = client.get(url)
        .send()
        .await;

    let results = response.unwrap()
        .json::()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url {{baseUrl}}/account

http GET {{baseUrl}}/account

wget --quiet \
  --method GET \
  --output-document \
  - {{baseUrl}}/account

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/account")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()