Remove image background

post

https://api.photoeditapi.com/v1/generate/backgroundremoval

Remove the background from an image and optionally replace it with a solid colour, blur effect, or transparent layer.

Synchronous: Unlike image generation, this endpoint processes the image immediately and returns the result in the same response — no polling required.

Credit cost: 1 credit per request.

Idempotency: Duplicate requests with the same image and background settings return the existing result.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

image

string

required

Source image to process. Must be a public HTTPS URL or an upload key returned by POST /upload/get-signed-image-upload-url.

background

enum

What to replace the background with. Defaults to transparent.

Value	Result
`"transparent"`	Transparent (RGBA) background
`"white"`	Solid white background
`"blur"`	Blurred version of the original background
`"#rrggbb"` or `"#rgb"`	Any hex colour
`[r, g, b]`	RGB array, each value 0–255

Named background type.

Headers

x-end-user-id

string

required

^[a-zA-Z0-9_\-~]+$

A stable, unique identifier for the end-user making the request. Accepts alphanumeric characters, dashes (-), underscores (_), and tildes (~). This maps the request to the correct credit balance and output history.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Background removal completed. The downloadUrl is available immediately.

400Request validation failed.

401Missing or invalid API key.

402The end-user does not have enough credits for this operation.

500Unexpected server error.