Remove an image's background

POST /v1/images/remove-background cuts the subject out of a picture and saves it as a PNG with a transparent background. The PNG goes into your workspace’s brand library, and the answer gives you its link. Use the link as the value of an image layer in a render.

In the app, the same tool is Remove background in the brand library and the editor.

Send a picture

Send the picture’s link as JSON, or upload the file as multipart/form-data in a field named file. name is optional in both: it names the new PNG in the brand library.

# A link to the picture
curl https://api.jamframe.com/v1/images/remove-background \
  -H "Authorization: Bearer $JAMFRAME_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com/photos/product.jpg", "name": "Product shot" }'

# Or upload the file
curl https://api.jamframe.com/v1/images/remove-background \
  -H "Authorization: Bearer $JAMFRAME_API_KEY" \
  -F "[email protected]" \
  -F "name=Product shot"

const res = await fetch("https://api.jamframe.com/v1/images/remove-background", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.JAMFRAME_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://example.com/photos/product.jpg",
    name: "Product shot",
  }),
});
const cutout = await res.json();
console.log(cutout.url, cutout.creditsCharged);

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['JAMFRAME_API_KEY']}"}

# A link to the picture
res = requests.post(
    "https://api.jamframe.com/v1/images/remove-background",
    headers=headers,
    json={"url": "https://example.com/photos/product.jpg", "name": "Product shot"},
)

# Or upload the file
with open("product.jpg", "rb") as f:
    res = requests.post(
        "https://api.jamframe.com/v1/images/remove-background",
        headers=headers,
        files={"file": f},
        data={"name": "Product shot"},
    )

print(res.json()["url"])

The picture must be:

• PNG, JPEG, GIF (the first frame is used) or WebP. SVG doesn’t work.
• At most 10 MB and about 50 megapixels.
• For url: a public http or https link. A base64 data:image/… URL works too.

The answer

The answer looks like this (asset is shortened):

{
  "url": "https://cdn.jamframe.com/workspaces/ws_123/images/as_456.png",
  "width": 2537,
  "height": 1897,
  "method": "local",
  "model": "u2net",
  "scaled": false,
  "creditsCharged": 1,
  "asset": {
    "id": "as_456",
    "kind": "image",
    "name": "Product shot (no background)",
    "url": "https://cdn.jamframe.com/workspaces/ws_123/images/as_456.png",
    "mimeType": "image/png",
    "tags": ["ai", "cutout"]
  }
}

The answer is not wrapped in data, unlike render answers.

Use the result in a render

Send url as the value of an image layer’s key:

{
  "templateId": "YOUR_TEMPLATE_ID",
  "modifications": {
    "photo": "https://cdn.jamframe.com/workspaces/ws_123/images/as_456.png"
  }
}

See Render images and PDFs.

Cost

These are AI credits, separate from render credits. A call that fails is refunded. See Credits.

Limits

• Each workspace can remove 120 backgrounds per 10 minutes. More answer 429 RATE_LIMITED. This counts on top of your per-minute limit.
• When the servers are busy, you can also get 429 RATE_LIMITED with detail.retryAfter (in seconds). Wait that long and try again.

Errors

See Errors for every other code.

Related

• Where the PNG is kept: Brand library
• Make images with AI in the app: AI images
• How AI credits work: Credits