Skip to main content
POST
Image Eraser
This is an async API that only returns the async task_id. Use the task_id to call the Get Async Task Result API to retrieve the image erasing result.
This is an async API that only returns the task_id of the async task. Use the task_id to call the Get Async Task Result API to retrieve the generated result.

Request Headers

string
required
Enum: application/json
string
required
Bearer authentication format: Bearer {{API Key}}.

Request Body

string
Mask image indicating the area to erase. Areas to erase should be white; areas to keep should be black.
string
required
The original image to process.
string
Text prompt specifying the object or area to remove from the image. For example: ‘dog’ or ‘hat’.
string
default:"jpeg"
Output image format.Possible values: jpeg, png, webp

Response

string
required
Use the task_id to call the Get Async Task Result API to retrieve the generated output.