Remove background
POST/v2/artworks/remove-background
Remove the background from an image and return a new artwork with a transparent background. Handy for product shots, portraits, or any prep work before compositing.
Request
- application/json
Body
required
URL of the image to remove the background from.
Possible values: [png, webp]
Output image format. Defaults to "png". Supported values: "png", "webp".
Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion.
Responses
- 202
- 400
- 401
- 403
- 429
- 500
Artwork accepted; webhook fires on completion.
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [remove_background]
parameters
object
required
URL of the image to remove the background from.
Possible values: [png, webp]
Output image format. Defaults to "png". Supported values: "png", "webp".
Optional webhook URL. When provided, the server will POST the final artwork result to this URL upon completion.
Possible values: [starting, processing, succeeded, failed, canceled]
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"artworkType": "remove_background",
"parameters": {
"imageUrl": "string",
"imageFormat": "png",
"webhook": "string"
},
"duration": 0,
"results": [
"string"
],
"status": "starting",
"createdAt": "2024-07-29T15:51:28.071Z"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Available only when the message includes additional error details.
{
"message": "string",
"statusCode": 0,
"error": "string"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
Available only when the message includes additional error details.
{
"message": "string",
"statusCode": 0,
"error": "string"
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Available only when the message includes additional error details.
{
"message": "string",
"statusCode": 0,
"error": "string"
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
Available only when the message includes additional error details.
{
"message": "string",
"statusCode": 0,
"error": "string"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
Available only when the message includes additional error details.
{
"message": "string",
"statusCode": 0,
"error": "string"
}