background

Media · Image · Replace image background

Replace ONLY the background behind the detected subject — with a solid color, another image, or transparency. Set replace_type to color (needs replace_color), image (needs replace_image), or transparent. To blur rather than replace use blurBackground; to cut the subject out entirely use removeBackground. Async — returns a task_id (auto-polled).

post/api/v1/tools/replace-image

Request

  • Base URL
    https://api.simplified.com
  • Auth
    API key in header Authorization

Request body

image_urlstring required

URL of the source image.

replace_type'transparent' | 'image' | 'color' required

What to replace the background with.

replace_colorstring

Hex color for replacement (required when replace_type=color).

replace_imagestring

URL of background image (required when replace_type=image).

Response

Async task queued.

task_idstring

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

Changes

No recorded changes to this operation across all 1 revision of this API.