POST
/
v1
/
image-background-remover
curl --request POST \
  --url https://api.magichour.ai/v1/image-background-remover \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Background Remover image",
  "assets": {
    "image_file_path": "api-assets/id/1234.png"
  }
}'
{
  "id": "clx7uu86w0a5qp55yxz315r6r",
  "frame_cost": 5
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
Body
​
assets
object
required

Provide the assets for background removal

​
name
string
default:Background Remover - dateTime

The name of image

Example:

"Background Remover image"

Response

200
application/json

Success

​
id
string
required

Unique ID of the image. This value can be used in the get image project API to fetch additional details such as status

Example:

"clx7uu86w0a5qp55yxz315r6r"

​
frame_cost
integer
required

The frame cost of the image generation

Example:

5

Was this page helpful?

Face Swap Photo