---
title: "Replace an image background"
method: POST
path: "/v2/tool/replace-background"
tags: ["edit-workflow"]
---

# Replace an image background

`POST /v2/tool/replace-background`

Replaces the background of one image from a text prompt while preserving
the foreground subject. The foreground mask is detected automatically;
callers do not provide a mask.

The request is processed asynchronously. Poll
`GET /v1/generations/{generation_id}` with the returned `generation_id`
until the generation is completed or failed.

Supply exactly one source transport: an existing `AssetIdentifier` in
`image_asset_identifier`, or raw `image` bytes in a multipart request.
Supplying both or neither is rejected with a 400.

## Request body

- ReplaceBackgroundRequest — Supply exactly one of `image_asset_identifier` or multipart `image` bytes. The prompt describes only the desired new background; the foreground subject is detected and preserved automatically.
  - `image_asset_identifier` AssetIdentifier — An identifier for an ideogram asset.
    - `asset_type` 'ASSET' | 'CANVAS_ASSET' | 'LAYERED_ASSET' | 'RESPONSE' | 'UPLOAD', required
    - `asset_id` string, required
  - `image` string, binary — Raw source-image bytes. JPEG, PNG, WEBP, HEIF, AVIF, GIF, BMP, TIFF, and MPO are supported, up to 50 MB. Multipart requests only.
  - `prompt` string, required — Plain-language description of the desired new background.
  - `quality` 'LOW' | 'MEDIUM' | 'HIGH' — The quality tier for the image edit. Higher tiers may improve detail and take longer to complete.
  - `num_images` integer — The number of images to generate.
  - `private` boolean — If true, the user is requesting private generation. If omitted, this defaults to the user's plan entitlement. Enterprise generations are always private.
  - `webhook_url` string, uri — HTTPS URL that Ideogram delivers the generated result to. Ideogram sends a JSON POST to this URL once all images for the request have finished generating. The body mirrors the synchronous generate response: `request_id`, `created`, and a `data` array containing every generated image (`url`, `prompt`, `resolution`, `seed`, `is_image_safe`). Each delivery is signed with Ed25519 and verifiable against the public keys at `https://api.ideogram.ai/v1/.well-known/jwks.json`. Must be HTTPS; private and loopback hosts and the cloud metadata service are rejected.

## Response `200`

Background replacement accepted for asynchronous processing.

- ReplaceBackgroundResponse — Acknowledgement that the workflow was accepted.
  - `generation_id` string, required — URL-safe base64 ID accepted by the generation polling endpoint.

## Other responses

- `400` — Invalid input provided.
- `401` — Unauthorized.
- `402` — Insufficient credits or quota.
- `403` — Not authorized to replace backgrounds.
- `404` — The source asset was not found or is not readable.
- `422` — The prompt did not pass safety checks.
- `429` — Too many requests.
- `503` — Background replacement is temporarily unavailable.

## Changes

- **2026-08-31** `583d86789548` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/changes/v2/tool/replace-background/post.md)

---

[API](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0.md) · [All operations](https://skmtc.dev/ideogram/apis/ideogram-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ideogram/ideogram-openapi-3-0/revisions/583d86789548/schema)