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

ParameterDescription
backgroundstringWhat the cut-out sits on. Default "transparent".One of: transparent, white, color
color_hexstringThe color when background is "color", like "#efe8dc".
shadowbooleanAdds a soft contact shadow under the subject (white and color backgrounds). Default false.
image_urlstringPublic https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused.
image_base64stringThe photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead.
upload_idstringAn id from POST /uploads.
imagesarraySeveral 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_urlstringhttps address Garmo POSTs the finished job to (signed, see Webhooks).
metadataobjectYour 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
  }'

Response: 202 Accepted

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

GET /jobs/{id}
{
  "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.