Sign in

v47

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01360485.4 KB
Image Projects

Image Background Remover

Remove background from image. Each image costs 5 credits.

post/v1/image-background-remover

Request body

namestring

Give your image a custom name for easy identification.

Example request

{
  "name": "My Background Remover image",
  "assets": {
    "image_file_path": "api-assets/id/1234.png",
    "background_image_file_path": "api-assets/id/1234.png"
  }
}

Response

Success

idstring required

Unique ID of the image. Use it with the Get image Project API to fetch status and downloads.

credits_chargedinteger required

The amount of credits deducted from your account to generate the image. We charge credits right when the request is made.

If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.

Example response

{
  "id": "cuid-example",
  "credits_charged": 5
}