# Ideogram Object Removal API

> רימוווז אָביעקטן אָן אַ פּראָמפּט מיט אַ שוואַרץ־ווײַסער מאַסקע, אַרײַנגערעכנט שאָטנס און אָפּשפּיגלונגען

רימוווז אָביעקטן פֿון אַ פֿאָטאָ אָן קיין טעקסט־פּראָמפּט. צושטעלן די מקור־בילד (`image_url`) און אַ מאַסקע (`mask_url`) מיט די זעלבע דימענסיעס: ווײַסע פּיקסעלן ווערן אויסגעמעקט, שוואַרצע ווערן געהאַלטן. די סצענע ווערט רעקאָנסטרויִרט, און אויך די שאָטנס און אָפּשפּיגלונגען ווערן אַוועקגענומען. יעדער טעקע קען זײַן ביז 10MB.

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

## Pricing

Price: **$0.03 / image**. Billed per generated image.

The full example input below costs $0.03 = 30 API credits (1 image × 30 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/object-removal` 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_url` | `image` | string (image URL) | yes |  |  | מקור־בילד מיטן אָביעקט וואָס זאָל ווערן אַוועקגענומען; די פֿײַל־גרייס טאָר נישט איבערגיין 10 MB. |
| `mask_url` | `mask` | string (image URL) | yes |  |  | אוועקנעם־מאַסקע, מיט ווײַס פֿאַר פּיקסעלן וואָס זאָלן ווערן אַוועקגענומען און שוואַרץ פֿאַר פּיקסעלן וואָס זאָלן בלײַבן. צושטעלן אַ שוואַרץ־און־ווײַס בילד ניט גרעסער ווי 10 MB, מיט די זעלבע דימענסיעס ווי דער מקור. |

File parameters (`image`, `mask`) 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
{
  "image": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "mask": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
}
```

A fuller example:

```json
{
  "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
  "mask_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/object-removal?wait=20" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_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/object-removal?wait=20", {
  method: "POST",
  headers,
  body: JSON.stringify({
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_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 = {
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_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/object-removal", 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/object-removal",
      "input": {
        "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
        "mask_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/object-removal",
  "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": 30,
    "usd": "0.03",
    "charged": 30,
    "refunded": 0
  },
  "input": {
    "image_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg",
    "mask_url": "https://content.doitong.com/images/showcase/v3/gen_fox_cartoon.jpg"
  },
  "output": {
    "image": {
      "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
    }
  },
  "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 |
|---|---|---|
| `image` | object {url, content_type, file_name, file_size} | רעזולטאַט־בילד נאָך דעם אַוועקנעמען פֿונעם געמאַסקטן אָביעקט. |

## 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 Replace Background](https://doitong.com/developers/models/ideogram/v3/replace-background.md) (`ideogram/v3/replace-background`): from $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/object-removal
- 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/object-removal
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/ideogram/object-removal