---
title: "Replace Background with Ideogram 3.0"
method: POST
path: "/v1/ideogram-v3/replace-background"
tags: ["generate"]
---

# Replace Background with Ideogram 3.0

`POST /v1/ideogram-v3/replace-background`

Replace the background of a given image synchronously using a prompt with Ideogram 3.0. The foreground subject
will be identified and kept, while the background is replaced based on the prompt and chosen style.
Supported image formats include JPEG, PNG, and WebP.
Images links are available for a limited period of time; if you would like to keep the image, you must download it.

## Headers

- `Api-Key` string, required

## Response `200`

Background replacement generated successfully.

- ImageGenerationResponseV3 — The response which contains information about the generated image, including the download link. Images links are available for a limited period of time; if you would like to keep the image, you must download it.
  - `created` string, date-time, required — The time the request was created.
  - `data` ImageGenerationObjectV3[], required — A list of ImageObjects that contain the generated image(s).
    - `url` string, uri, nullable — The direct link to the image generated.
    - `prompt` string, required — The prompt used for the generation. This may be different from the original prompt.
    - `resolution` '512x1536' | '576x1408' | '576x1472' | '576x1536' | '640x1344' | '640x1408' | '640x1472' | '640x1536' | '704x1152' | '704x1216' | '704x1280' | '704x1344' | '704x1408' | '704x1472' | '736x1312' | '768x1088' | '768x1216' | '768x1280' | '768x1344' | '800x1280' | '832x960' | '832x1024' | '832x1088' | '832x1152' | '832x1216' | '832x1248' | '864x1152' | '896x960' | '896x1024' | '896x1088' | '896x1120' | '896x1152' | '960x832' | '960x896' | '960x1024' | '960x1088' | '1024x832' | '1024x896' | '1024x960' | '1024x1024' | '1088x768' | '1088x832' | '1088x896' | '1088x960' | '1120x896' | '1152x704' | '1152x832' | '1152x864' | '1152x896' | '1216x704' | '1216x768' | '1216x832' | '1248x832' | '1280x704' | '1280x768' | '1280x800' | '1312x736' | '1344x640' | '1344x704' | '1344x768' | '1408x576' | '1408x640' | '1408x704' | '1472x576' | '1472x640' | '1472x704' | '1536x512' | '1536x576' | '1536x640', required — The resolutions supported for Ideogram 3.0.
    - `upscaled_resolution` string — Output resolution, only used if operations alters image dimensions, such as upscale, crop etc.
    - `is_image_safe` boolean, required — Whether this request passes safety checks. If false, the url field will be empty.
    - `seed` integer, required — Random seed. Set for reproducible generation.
    - `style_type` 'AUTO' | 'GENERAL' | 'REALISTIC' | 'DESIGN' | 'FICTION' — The style type to generate with.

## Other responses

- `400` — Invalid input provided.
- `401` — Not authorized to generate an image.
- `422` — Prompt or Initial Image failed the safety checks.
- `429` — Too many requests.

---

[API](https://skmtc.net/ideogram/apis/api-reference.md) · [All operations](https://skmtc.net/ideogram/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideogram/api-reference/versions/f6a8c81158c0/schema)