Skip to navigation

Media · Image · Remove image background

View as Markdown

Removes the background from an image. Returns a task_id — poll for result.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

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

Request

This endpoint expects an object.
image_urlstringRequired
URL of the source image.
magic_cropbooleanOptional

Auto-crop to subject bounding box after removal.

background_colorstringOptional

Fill color after removal (hex, e.g. "#ffffff"). Omit for transparent.

output_formatenumOptional

Output format. Default png (supports transparency).

Allowed values:

Response

Async task queued.
task_idstringOptional

Poll GET /api/v1/tasks/{task_id} until SUCCESS or FAILURE.