> Garmo API docs as Markdown. This page: https://garmo.studio/api/docs/remove-background/ · All docs in one file: https://garmo.studio/api/docs/llms-full.txt

# Remove background

POST/edit/remove-background

Cuts the product or model out of the photo, onto transparency, white or a color of your choice.

Cost: 1 credit per photo. Images: Send one photo the same way, or up to 10 in images[] (or multipart files named images[]). It makes one image per photo, at most 12 per request.

Overview and examples: Background remover API.

## Parameters

- Parameter | Description
- background  string | What the cut-out sits on. Default  "transparent" . One of:  transparent ,  white ,  color
- color_hex  string | The color when background is "color", like "#efe8dc".
- shadow  boolean | Adds a soft contact shadow under the subject (white and color backgrounds). Default  false .
- image_url  string | Public https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused.
- image_base64  string | The photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead.
- upload_id  string | An id from POST /uploads.
- images  array | Several photos at once (up to 10); each item is a URL string or an object with image_url, image_base64 or upload_id. Each photo is edited on its own.
- webhook_url  string | https address Garmo POSTs the finished job to (signed, see Webhooks).
- metadata  object | Your own JSON object (up to 1,000 characters), returned with the job and in the webhook.
Header Idempotency-Key (optional): see Retries and idempotency.

## Example

```
curl https://api.garmo.studio/v1/edit/remove-background \
  -H "Authorization: Bearer $GARMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://shop.example/products/bag-77.jpg",
    "background": "white",
    "shadow": true
  }'
```

```
const r = await fetch("https://api.garmo.studio/v1/edit/remove-background", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.GARMO_API_KEY}`,
    "Idempotency-Key": "order-123-remove-background",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"image_url": "https://shop.example/products/bag-77.jpg", "background": "white", "shadow": true}),
});
const job = await r.json();
console.log(job.id, job.status);
```

```
import os, requests

r = requests.post(
    "https://api.garmo.studio/v1/edit/remove-background",
    headers={"Authorization": f"Bearer {os.environ['GARMO_API_KEY']}", "Idempotency-Key": "order-123-remove-background"},
    json={
        "image_url": "https://shop.example/products/bag-77.jpg",
        "background": "white",
        "shadow": True,
    },
)
job = r.json()
print(job["id"], job["status"])
```

```
 true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode(["image_url" => "https://shop.example/products/bag-77.jpg", "background" => "white", "shadow" => true]),
    CURLOPT_HTTPHEADER => ["Authorization: Bearer " . getenv("GARMO_API_KEY"), "Idempotency-Key: order-123-remove-background", "Content-Type: application/json"],
]);
$job = json_decode(curl_exec($ch), true);
echo $job["id"], " ", $job["status"];
```

```
require "net/http"
require "json"

uri = URI("https://api.garmo.studio/v1/edit/remove-background")
req = Net::HTTP::Post.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("GARMO_API_KEY")}"
req["Idempotency-Key"] = "order-123-remove-background"
req["Content-Type"] = "application/json"
req.body =  res = HttpClient.newHttpClient().send(req, HttpResponse.BodyHandlers.ofString());
        System.out.println(res.statusCode() + " " + res.body());
    }
}
```

### Response: 202 Accepted

```
{
  "id": "job_8Kq2xV7mPz4LtR9wNc3B",
  "object": "job",
  "tool": "remove-background",
  "status": "processing",
  "livemode": true,
  "outputs": [
    {
      "id": "out_1",
      "status": "processing",
      "label": "White · shadow"
    }
  ],
  "credits_charged": 1,
  "credits_refunded": 0,
  "metadata": {
    "sku": "DR-123"
  },
  "created_at": "2026-11-19T14:02:11Z",
  "completed_at": null
}
```

### The finished job

```
{
  "id": "job_8Kq2xV7mPz4LtR9wNc3B",
  "object": "job",
  "tool": "remove-background",
  "status": "completed",
  "livemode": true,
  "outputs": [
    {
      "id": "out_1",
      "status": "succeeded",
      "label": "White · shadow",
      "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…",
      "url_expires_at": "2026-11-20T14:00:00Z"
    }
  ],
  "credits_charged": 1,
  "credits_refunded": 0,
  "metadata": {
    "sku": "DR-123"
  },
  "created_at": "2026-11-19T14:02:11Z",
  "completed_at": "2026-11-19T14:02:58Z"
}
```

## Errors

400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors.
