Remove Background

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@photo.jpg" \
  -o result.png

from poof import Poof

client = Poof(api_key="YOUR_API_KEY")
result = client.remove_background("photo.jpg")
result.save("result.png")

import { Poof } from '@poof-bg/js';
import fs from 'fs/promises';

const poof = new Poof({ apiKey: 'YOUR_API_KEY' });
const image = await fs.readFile('photo.jpg');
const result = await poof.removeBackground(image);
await fs.writeFile('result.png', Buffer.from(result.data));

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@product.jpg" \
  -F "format=jpg" \
  -F "channels=rgb" \
  -F "bg_color=#ffffff" \
  -o product-white-bg.jpg

result = client.remove_background(
    "product.jpg",
    format="jpg",
    channels="rgb",
    bg_color="#ffffff"
)
result.save("product-white-bg.jpg")

const result = await poof.removeBackground(image, {
  format: 'jpg',
  channels: 'rgb',
  bgColor: '#ffffff'
});

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@photo.jpg" \
  -F "channels=alpha" \
  -o mask.png

result = client.remove_background("photo.jpg", channels="alpha")
result.save("mask.png")

const result = await poof.removeBackground(image, { channels: 'alpha' });
await fs.writeFile('mask.png', Buffer.from(result.data));

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@photo.jpg" \
  -F "size=preview" \
  -F "crop=true" \
  -o thumbnail.png

result = client.remove_background(
    "photo.jpg",
    size="preview",
    crop=True
)
result.save("thumbnail.png")

const result = await poof.removeBackground(image, {
  size: 'preview',
  crop: true
});

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@product.jpg" \
  -F "crop=true" \
  -F "padding=10%,7.5%" \
  -o product-cropped.png

result = client.remove_background(
    "product.jpg",
    crop=True,
    padding="10%,7.5%"
)
result.save("product-cropped.png")

const result = await poof.removeBackground(image, {
  crop: true,
  padding: '10%,7.5%'
});

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@product.jpg" \
  -F "crop=true" \
  -F "width=500" \
  -F "height=500" \
  -o product-500.png

result = client.remove_background("product.jpg", crop=True, width=500, height=500)
result.save("product-500.png")

const result = await poof.removeBackground(image, { crop: true, width: 500, height: 500 });

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@photo.jpg" \
  -F "width=1080" \
  -F "height=1080" \
  -F "fit=cover" \
  -F "format=jpg" \
  -F "bg_color=#ffffff" \
  -o square-1080.jpg

result = client.remove_background(
    "photo.jpg",
    width=1080,
    height=1080,
    fit="cover",
    format="jpg",
    bg_color="#ffffff"
)

const result = await poof.removeBackground(image, {
  width: 1080,
  height: 1080,
  fit: 'cover',
  format: 'jpg',
  bgColor: '#ffffff',
});

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@icon.png" \
  -F "width=1000" \
  -F "height=1000" \
  -F "fit=scale-down" \
  -o icon-1000.png

result = client.remove_background("icon.png", width=1000, height=1000, fit="scale-down")

const result = await poof.removeBackground(image, { width: 1000, height: 1000, fit: 'scale-down' });

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@photo.jpg" \
  -F "format=webp" \
  -o result.webp

result = client.remove_background("photo.jpg", format="webp")
result.save("result.webp")

const result = await poof.removeBackground(image, { format: 'webp' });

# 1. Submit the video (returns the job as JSON; note the "id")
curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@clip.mp4" \
  -F "format=webm"

# 2. Poll the job every few seconds until "status" is "completed" (or "failed")
curl https://api.poof.bg/v1/jobs/job_8f3a1c2e9b7d4a10 \
  -H "x-api-key: YOUR_API_KEY"

# 3. Download the result from "result_url" (a public CDN link, no API key needed)
curl -o clip-nobg.webm \
  https://cdn.poof.bg/1d/jobs/job_8f3a1c2e9b7d4a10/result.webm

import time
import requests

API = "https://api.poof.bg/v1"
headers = {"x-api-key": "YOUR_API_KEY"}

# 1. Submit the video
with open("clip.mp4", "rb") as f:
    r = requests.post(
        f"{API}/remove",
        headers=headers,
        files={"file": f},
        data={"format": "webm"},
    )
r.raise_for_status()
job = r.json()
print(f"Job {job['id']}: {job['duration_seconds']} s, {job['credits']} credits")

# 2. Poll every few seconds until the job finishes
while job["status"] not in ("completed", "failed"):
    time.sleep(3)
    r = requests.get(f"{API}/jobs/{job['id']}", headers=headers)
    r.raise_for_status()
    job = r.json()
    print(f"{job['status']} {job['progress']:.0%}")

if job["status"] == "failed":
    raise RuntimeError(f"{job['error']['code']}: {job['error']['message']}")

# 3. Download the result (a public CDN link, no API key needed)
with requests.get(job["result_url"], stream=True) as r:
    r.raise_for_status()
    with open("clip-nobg.webm", "wb") as out:
        for chunk in r.iter_content(chunk_size=1024 * 1024):
            out.write(chunk)

import fs from 'node:fs';
import { readFile } from 'node:fs/promises';
import { Readable } from 'node:stream';
import { pipeline } from 'node:stream/promises';
import type { ReadableStream as NodeReadableStream } from 'node:stream/web';

const API = 'https://api.poof.bg/v1';
const headers = { 'x-api-key': 'YOUR_API_KEY' };

// 1. Submit the video
const form = new FormData();
form.append('file', new Blob([await readFile('clip.mp4')]), 'clip.mp4');
form.append('format', 'webm');

const submit = await fetch(`${API}/remove`, { method: 'POST', headers, body: form });
if (!submit.ok) throw new Error(await submit.text());
let job = await submit.json();
console.log(`Job ${job.id}: ${job.duration_seconds} s, ${job.credits} credits`);

// 2. Poll every few seconds until the job finishes
while (job.status !== 'completed' && job.status !== 'failed') {
  await new Promise((r) => setTimeout(r, 3000));
  const res = await fetch(`${API}/jobs/${job.id}`, { headers });
  if (!res.ok) throw new Error(await res.text());
  job = await res.json();
  console.log(job.status, `${Math.round(job.progress * 100)}%`);
}
if (job.status === 'failed') throw new Error(`${job.error.code}: ${job.error.message}`);

// 3. Stream the result to disk (a public CDN link, no API key needed)
const result = await fetch(job.result_url);
if (!result.ok) throw new Error(await result.text());
await pipeline(
  Readable.fromWeb(result.body as NodeReadableStream),
  fs.createWriteStream('clip-nobg.webm')
);

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@clip.mp4" \
  -F "format=mp4" \
  -F "bg_color=#00ff00"

with open("clip.mp4", "rb") as f:
    job = requests.post(
        f"{API}/remove",
        headers=headers,
        files={"file": f},
        data={"format": "mp4", "bg_color": "#00ff00"},
    ).json()

form.append('file', new Blob([await readFile('clip.mp4')]), 'clip.mp4');
form.append('format', 'mp4');
form.append('bg_color', '#00ff00');

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@clip.mp4" \
  -F "format=mov"

with open("clip.mp4", "rb") as f:
    job = requests.post(
        f"{API}/remove",
        headers=headers,
        files={"file": f},
        data={"format": "mov"},
    ).json()

form.append('file', new Blob([await readFile('clip.mp4')]), 'clip.mp4');
form.append('format', 'mov');

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@clip.mp4" \
  -F "format=mp4" \
  -F "channels=alpha"

with open("clip.mp4", "rb") as f:
    job = requests.post(
        f"{API}/remove",
        headers=headers,
        files={"file": f},
        data={"format": "mp4", "channels": "alpha"},
    ).json()

form.append('file', new Blob([await readFile('clip.mp4')]), 'clip.mp4');
form.append('format', 'mp4');
form.append('channels', 'alpha');

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@clip.mp4" \
  -F "format=gif" \
  -F "size=preview"

with open("clip.mp4", "rb") as f:
    job = requests.post(
        f"{API}/remove",
        headers=headers,
        files={"file": f},
        data={"format": "gif", "size": "preview"},
    ).json()

form.append('file', new Blob([await readFile('clip.mp4')]), 'clip.mp4');
form.append('format', 'gif');
form.append('size', 'preview');

curl -X POST https://api.poof.bg/v1/remove \
  -H "x-api-key: YOUR_API_KEY" \
  -F "url=https://example.com/videos/clip.mp4" \
  -F "format=webm"

job = requests.post(
    f"{API}/remove",
    headers=headers,
    data={"url": "https://example.com/videos/clip.mp4", "format": "webm"},
).json()

form.append('url', 'https://example.com/videos/clip.mp4');
form.append('format', 'webm');