Remove background from image

API Reference

Remove the background from an image. By default, returns the foreground as an RGBA image. Set output_type to mask to return the foreground mask instead.

Model:remove-background

Credit:1

post/v1/images/remove-background

Authorization — This endpoint requires an API key. Pass it in the api-key header on every request. Learn more

Parameters

Name	Type	Status	Description
`input_image`	file	Required	Image file or URL to remove the background from.
`output_type`	string	Optional	Choose `foreground` to return the foreground RGBA image, or `mask` to return the foreground mask. foregroundmask (default: `foreground`)

Responses

Background removed successfullyRemoveBackgroundResponse

Field	Type	Description
`data`	object[]
`url`	string	URL to download the selected result image
`box`	number[]	Bounding box [x1, y1, x2, y2] of foreground object

curl -X POST "https://api.snapedit.app/v1/images/remove-background" \
  -H "api-key: YOUR_API_KEY" \
  -F "input_image=@./image.jpg" \
  -F "output_type=foreground"

Response

{
  "data": [
    {
      "url": "https://outputs.snapedit.app/outputs/abc123.png",
      "box": [
        10,
        20,
        300,
        400
      ]
    }
  ]
}

Examples (2 examples)

Input

Output Foreground

Output Mask