Skip to main content
POST
Background Remover

Headers

Authorization
string

Body

application/json
model
enum<string>
required

Model name. Must be background-remover.

Available options:
background-remover
image_url
string<uri>
required

URL of the image to cut out. Must be an https:// link that is publicly reachable, at most 50 MB and at most 36 megapixels.

Minimum string length: 1
image_type
enum<string>
default:general

What kind of image it is. general (default) for photos; anime for anime characters and illustrations only, since it breaks hair into fragments on real photos.

Available options:
general,
anime
background_color
string

Optional. A hex colour such as #FFFFFF. When set, the subject is placed on this solid colour and the PNG has no transparency. When omitted, the background is transparent.

Pattern: ^#?[0-9a-fA-F]{6}$
Example:

"#FFFFFF"

custom_callback_url
string<uri>

Optional. A publicly accessible HTTPS URL. When the task status changes (processing / success / failed), GoEnhance sends a POST request to this URL. The request body is identical to the response of GET /api/v1/jobs/detail. If your server does not respond with HTTP 200, the notification is retried up to 3 times, with a 3-second timeout per attempt.

Example:

"https://your-server.com/goenhance/callback"

Response

code
integer
required
msg
string
required
data
object
required