# Ideogram Replace Background API

> تعویض پس‌زمینه تصویر بر اساس پرامپت، با حفظ سوژه

پس‌زمینه تصویر (`image_url`) را بر اساس `prompt` متنیِ توصیف‌کننده صحنه جدید جایگزین می‌کند. مراجع سبک، `style_codes`، `color_palette`، `style` و `style_preset` ظاهر را هدایت می‌کنند. سرعت رندر TURBO، BALANCED یا QUALITY است و می‌توان 1 تا 8 تصویر دریافت کرد.

- Model id: `ideogram/v3/replace-background`
- Made by: Ideogram
- Category: Image Editing
- Output: image
- Price: from $0.03 / image (cheapest run $0.03 (30 API credits))
- Run: `POST https://api.doitong.com/v1/run/ideogram/v3/replace-background`
- Quote: `POST https://api.doitong.com/v1/quote/ideogram/v3/replace-background`
- Docs page: https://doitong.com/fa/developers/models/ideogram/v3/replace-background

## Pricing

Price: **from $0.03 / image** (the lowest tier; the quote prices your exact input). Billed per generated image (`num_images`, default 1).

Price rules (the first rule that matches the input wins; a parameter you leave out counts as its default):

- When `rendering_speed` = BALANCED: $0.06 (60 API credits) / image
- When `rendering_speed` = QUALITY: $0.09 (90 API credits) / image

The full example input below costs $0.06 = 60 API credits (1 image × 60 API credits).

Prices are the upstream price in USD, paid from the API balance in API credits (1000 API credits = 1 USD). `POST https://api.doitong.com/v1/quote/ideogram/v3/replace-background` with the same JSON body returns the exact price for that input; the quote is exactly what a run charges. Invalid input is never charged and failed or canceled requests are refunded automatically.

## Input parameters

Send either the canonical name or the native field name (not both). Canonical names are the same across models.

| Parameter | Canonical name | Type | Required | Default | Allowed values / range | Description |
|---|---|---|---|---|---|---|
| `image_urls` | `images` | array of image URL \| null | no |  |  | تصاویر مرجع سبک در قالب JPEG، PNG یا WebP. اندازه ترکیبی آن‌ها نباید از 10 MB بیشتر باشد. |
| `rendering_speed` |  | enum (string) | no | `BALANCED` | `TURBO`, `BALANCED`, `QUALITY` | تنظیم سرعت رندر. |
| `color_palette` |  | object {members, name} \| null | no |  |  | پالت رنگ استفاده‌شده هنگام تولید. یا یک پیش‌تنظیم را از طریق name مشخص کنید، یا رنگ‌های هگزادسیمال صریح را از طریق members ارائه دهید؛ در صورت نیاز وزن‌ها را نیز اضافه کنید. |
| `color_palette.members` |  | array of object {rgb, color_weight} \| null | no |  |  | فهرست اعضای پالت که رنگ‌های پالت را تعریف می‌کند. |
| `color_palette.members[].rgb` |  | object {r, g, b} | yes |  |  | رنگ عضو پالت به‌صورت RGB. |
| `color_palette.members[].color_weight` |  | number \| null | no | `0.5` | 0.05 – 1 | وزن اختصاص‌یافته به این رنگ در پالت. |
| `color_palette.name` |  | enum (string) \| null | no |  | `EMBER`, `FRESH`, `JUNGLE`, `MAGIC`, `MELON`, `MOSAIC`, `PASTEL`, `ULTRAMARINE` | انتخاب پیش‌تنظیم پالت رنگ. |
| `style_codes` |  | array of string \| null | no |  |  | کدهای سبک تصویر که به‌صورت رشته‌های هگزادسیمال 8 نویسه‌ای ارائه می‌شوند؛ هنگام استفاده از این فهرست، هم style_reference_images و هم style را حذف کنید. |
| `style` |  | enum (string) \| null | no |  | `AUTO`, `GENERAL`, `REALISTIC`, `DESIGN` | نوع سبک استفاده‌شده برای تولید؛ با style_codes قابل استفاده هم‌زمان نیست. |
| `expand_prompt` |  | boolean | no | `true` |  | کلید فعال‌سازی استفاده از MagicPrompt برای تولید درخواست. |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 8 | تعداد تصاویری که باید تولید شوند. |
| `seed` |  | integer \| null | no |  |  | مقدار سید برای تولید عدد تصادفی. |
| `style_preset` |  | enum (string) \| null | no |  | `80S_ILLUSTRATION`, `90S_NOSTALGIA`, `ABSTRACT_ORGANIC`, `ANALOG_NOSTALGIA`, `ART_BRUT`, `ART_DECO`, `ART_POSTER`, `AURA`, `AVANT_GARDE`, `BAUHAUS`, `BLUEPRINT`, `BLURRY_MOTION`, `BRIGHT_ART`, `C4D_CARTOON`, `CHILDRENS_BOOK`, `COLLAGE`, `COLORING_BOOK_I`, `COLORING_BOOK_II`, `CUBISM`, `DARK_AURA`, `DOODLE`, `DOUBLE_EXPOSURE`, `DRAMATIC_CINEMA`, `EDITORIAL`, `EMOTIONAL_MINIMAL`, `ETHEREAL_PARTY`, `EXPIRED_FILM`, `FLAT_ART`, `FLAT_VECTOR`, `FOREST_REVERIE`, `GEO_MINIMALIST`, `GLASS_PRISM`, `GOLDEN_HOUR`, `GRAFFITI_I`, `GRAFFITI_II`, `HALFTONE_PRINT`, `HIGH_CONTRAST`, `HIPPIE_ERA`, `ICONIC`, `JAPANDI_FUSION`, `JAZZY`, `LONG_EXPOSURE`, `MAGAZINE_EDITORIAL`, `MINIMAL_ILLUSTRATION`, `MIXED_MEDIA`, `MONOCHROME`, `NIGHTLIFE`, `OIL_PAINTING`, `OLD_CARTOONS`, `PAINT_GESTURE`, `POP_ART`, `RETRO_ETCHING`, `RIVIERA_POP`, `SPOTLIGHT_80S`, `STYLIZED_RED`, `SURREAL_COLLAGE`, `TRAVEL_POSTER`, `VINTAGE_GEO`, `VINTAGE_POSTER`, `WATERCOLOR`, `WEIRD`, `WOODBLOCK_PRINT` | پیش‌تنظیم سبکی که انتخاب آن تولید تصویر را هدایت می‌کند. |
| `prompt` |  | string | yes |  |  | پرامپت متنی؛ برای نمونه، شهر سایبرپانکی با آسمان‌خراش‌های نئونی. |
| `image_url` | `image` | string (image URL) | yes |  |  | URL اشاره‌کننده به تصویر نیازمند تعویض پس‌زمینه. |

File parameters (`images`, `image`) take a public `https://` URL, a `data:` URI up to 10 MB, or the `file_url` of an upload from `POST /files`.

## Example input

Required parameters only:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
  "image": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
}
```

A fuller example:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
  "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
}
```

## Run it

Set `DOITONG_API_KEY` to a key from https://doitong.com/developers/dashboard#keys. `?wait=20` returns the finished request in the same call when it is ready within 20 seconds; otherwise poll `GET /requests/{id}` (it also accepts `?wait=`), or pass `webhook_url`.

### curl

```bash
# Run the model; wait up to 20 s for the finished result in the same call
curl -X POST "https://api.doitong.com/v1/run/ideogram/v3/replace-background?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  }'

# Still "queued" or "running"? Poll with the id from the response:
curl "https://api.doitong.com/v1/requests/REQUEST_ID?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY"
```

### JavaScript

```javascript
const API = "https://api.doitong.com/v1";
const headers = {
  "Authorization": "Bearer " + process.env.DOITONG_API_KEY,
  "Content-Type": "application/json",
};

// Run the model; wait up to 20 s for the finished result in the same call
let res = await fetch(API + "/run/ideogram/v3/replace-background?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  }),
});
let request = await res.json();
if (!res.ok) throw new Error(request.error.code + ": " + request.error.message);

// Not finished yet: long-poll until it is
while (request.status === "queued" || request.status === "running") {
  res = await fetch(API + "/requests/" + request.id + "?wait=20", { headers });
  request = await res.json();
}
if (request.status !== "succeeded") throw new Error(JSON.stringify(request.error));
console.log(request.outputs.map((o) => o.url), request.cost.credits + " API credits ($" + request.cost.usd + ")");
```

### Python

```python
import os
import requests

API = "https://api.doitong.com/v1"
headers = {"Authorization": "Bearer " + os.environ["DOITONG_API_KEY"]}

payload = {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/ideogram/v3/replace-background", params={"wait": 20}, json=payload, headers=headers)
request = r.json()
if not r.ok:
    raise RuntimeError(request["error"]["code"] + ": " + request["error"]["message"])

# Not finished yet: long-poll until it is
while request["status"] in ("queued", "running"):
    request = requests.get(API + "/requests/" + request["id"], params={"wait": 20}, headers=headers).json()
if request["status"] != "succeeded":
    raise RuntimeError(request["error"])
print([o["url"] for o in request["outputs"]], request["cost"]["credits"], "API credits", "$" + request["cost"]["usd"])
```

### MCP

The MCP server at `https://api.doitong.com/v1/mcp` exposes the tools `search_models`, `get_model`, `quote`, `run`, `get_request`, `cancel_request`, `list_requests`, `create_upload` and `get_account`. A `run` call for this model:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "run",
    "arguments": {
      "model_id": "ideogram/v3/replace-background",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
        "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
      },
      "wait_seconds": 20
    }
  }
}
```

## Response

Every call returns a request object. `status` is one of `queued`, `running`, `succeeded`, `failed`, `canceled`. `outputs` lists the generated files with URLs on our storage (kept forever, or 7 days with `?storage=temporary`; `storage` says which); `output` is the model's own result object with the same URLs.

```json
{
  "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
  "object": "request",
  "model": "ideogram/v3/replace-background",
  "status": "succeeded",
  "created_at": "2026-10-20T12:00:00Z",
  "started_at": "2026-10-20T12:00:02Z",
  "completed_at": "2026-10-20T12:00:09Z",
  "queue_position": null,
  "cost": {
    "credits": 60,
    "usd": "0.06",
    "charged": 60,
    "refunded": 0
  },
  "input": {
    "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field",
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  },
  "output": {
    "images": [
      {
        "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
        "content_type": "image/jpeg",
        "file_name": "0-output.jpeg",
        "file_size": 1843200
      }
    ],
    "seed": 42
  },
  "outputs": [
    {
      "type": "image",
      "url": "https://content.doitong.com/dev-api/2026/10/20/req_8k2m4q7x1z9c3v5b6n0p2r4t/0-output.jpeg",
      "content_type": "image/jpeg",
      "file_size": 1843200,
      "width": 1024,
      "height": 768,
      "stored": true
    }
  ],
  "error": null,
  "metrics": {
    "inference_seconds": 6.8
  },
  "urls": {
    "self": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "cancel": "https://api.doitong.com/v1/requests/req_8k2m4q7x1z9c3v5b6n0p2r4t/cancel"
  }
}
```

### Output fields (`output`)

| Field | Type | Description |
|---|---|---|
| `images` | array of object {url, content_type, file_name, file_size} |  |
| `seed` | integer | مقدار سید استفاده‌شده برای تولید عدد تصادفی. |

## Related models

- [Ideogram Text to Image](https://doitong.com/developers/models/ideogram/v3.md) (`ideogram/v3`): from $0.03 / image
- [Ideogram Transparent](https://doitong.com/developers/models/ideogram/v3/generate-transparent.md) (`ideogram/v3/generate-transparent`): from $0.03 / image
- [Ideogram Object Removal](https://doitong.com/developers/models/ideogram/object-removal.md) (`ideogram/object-removal`): $0.03 / image
- [Ideogram V3 Edit](https://doitong.com/developers/models/ideogram/v3/edit.md) (`ideogram/v3/edit`): from $0.03 / image
- [Ideogram · v3 · Layerize Text](https://doitong.com/developers/models/ideogram/v3/layerize-text.md) (`ideogram/v3/layerize-text`): $0.09 / image
- [Ideogram · v3 · Reframe](https://doitong.com/developers/models/ideogram/v3/reframe.md) (`ideogram/v3/reframe`): from $0.03 / image
- [Ideogram · v3 · Remix](https://doitong.com/developers/models/ideogram/v3/remix.md) (`ideogram/v3/remix`): from $0.03 / image
- [Ideogram Remove Background](https://doitong.com/developers/models/ideogram/remove-background.md) (`ideogram/remove-background`): $0.01 / image

## Links

- HTML page: https://doitong.com/developers/models/ideogram/v3/replace-background
- All models and guides for AI agents: https://doitong.com/developers/llms.txt
- OpenAPI 3.1 with this model's typed request body: https://doitong.com/developers/openapi.json?model=ideogram/v3/replace-background
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/ideogram/v3/replace-background