Skip to main content
POST
/
v1
/
image-background-remover
Python
from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.image_background_remover.generate(
    assets={
        "background_image_file_path": "/path/to/1234.png",
        "image_file_path": "/path/to/1234.png",
    },
    name="Background Remover image",
    wait_for_completion=True,
    download_outputs=True,
    download_directory="outputs"
)
{
  "id": "cuid-example",
  "credits_charged": 5
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

​
assets
object
required

Provide the assets for background removal

​
name
string
default:Background Remover - dateTime

Give your image a custom name for easy identification.

Example:

"My Background Remover image"

Response

Success

Success

​
id
string
required

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

Example:

"cuid-example"

​
credits_charged
integer
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:

5