API Documentation

curl -H 'X-Api-Key: YOUR_API_KEY'           \
     -F 'image_file=@/path/to/photo.jpg'    \
     -F 'size=auto'                          \
     -f https://api.clearbg.ai/v1.0/removebg \
     -o result.png

import fs from "node:fs";

async function removeBg(blob) {
  const formData = new FormData();
  formData.append("size", "auto");
  formData.append("image_file", blob);

  const response = await fetch("https://api.clearbg.ai/v1.0/removebg", {
    method: "POST",
    headers: { "X-Api-Key": "YOUR_API_KEY" },
    body: formData,
  });

  if (response.ok) {
    return await response.arrayBuffer();
  } else {
    throw new Error(`${response.status}: ${response.statusText}`);
  }
}

const fileBlob = await fs.openAsBlob("/path/to/photo.jpg");
const result = await removeBg(fileBlob);
fs.writeFileSync("result.png", Buffer.from(result));

import requests

response = requests.post(
    "https://api.clearbg.ai/v1.0/removebg",
    files={"image_file": open("/path/to/photo.jpg", "rb")},
    data={"size": "auto"},
    headers={"X-Api-Key": "YOUR_API_KEY"},
)

if response.status_code == requests.codes.ok:
    with open("result.png", "wb") as out:
        out.write(response.content)
else:
    print("Error:", response.status_code, response.text)

$client = new GuzzleHttp\Client();
$res = $client->post('https://api.clearbg.ai/v1.0/removebg', [
    'multipart' => [
        ['name' => 'image_file', 'contents' => fopen('/path/to/photo.jpg', 'r')],
        ['name' => 'size', 'contents' => 'auto']
    ],
    'headers' => ['X-Api-Key' => 'YOUR_API_KEY']
]);

$fp = fopen("result.png", "wb");
fwrite($fp, $res->getBody());
fclose($fp);