# Ideogram Transparent API

> Testun-i-ddelwedd sy’n cynhyrchu delweddau gyda chefndiroedd tryloyw, pymtheg cymhareb agwedd

Yn cynhyrchu delweddau o `prompt` gyda chefndir tryloyw, sy’n ddefnyddiol ar gyfer sticeri, logos ac asedau i’w gosod ar gynlluniau eraill. Yn cynnig pymtheg cymhareb agwedd, rendro TURBO, BALANCED neu QUALITY, ehangu anogwr dewisol, anogwr negyddol, had, ac 1 i 8 delwedd fesul cais.

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

## 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/generate-transparent` 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 |
|---|---|---|---|---|---|---|
| `prompt` |  | string | yes |  |  |  |
| `aspect_ratio` |  | enum (string) | no | `1:1` | `1:3`, `3:1`, `1:2`, `2:1`, `9:16`, `16:9`, `10:16`, `16:10`, `2:3`, `3:2`, `3:4`, `4:3`, `4:5`, `5:4`, `1:1` | Cymhareb agwedd y ddelwedd ganlyniadol. |
| `rendering_speed` |  | enum (string) | no | `BALANCED` | `TURBO`, `BALANCED`, `QUALITY` | Gosodiad cyflymder ar gyfer rendro. |
| `expand_prompt` |  | boolean | no | `true` |  | Toglo defnydd MagicPrompt ar gyfer cynhyrchu cais. |
| `negative_prompt` |  | string | no | `` |  | Pennu cynnwys delwedd diangen, gan roi blaenoriaeth i ddisgrifiadau'r prif anogiad dros y disgrifiadau anogiad negyddol hyn. |
| `num_images` | `num_outputs` | integer | no | `1` | 1 – 8 | Nifer y delweddau i'w cynhyrchu. |
| `seed` |  | integer \| null | no |  |  | Gwerth hadau ar gyfer cynhyrchu rhifau ar hap. |

## Example input

Required parameters only:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
}
```

A fuller example:

```json
{
  "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
}
```

## 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/generate-transparent?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"
  }'

# 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/generate-transparent?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"
  }),
});
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",
}

# Run the model; wait up to 20 s for the finished result in the same call
r = requests.post(API + "/run/ideogram/v3/generate-transparent", 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/generate-transparent",
      "input": {
        "prompt": "A red fox trots through fresh snow at sunrise, soft golden light, shallow depth of field"
      },
      "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/generate-transparent",
  "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"
  },
  "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 | Gwerth hadau a ddefnyddir ar gyfer cynhyrchu rhifau ar hap. |

## Related models

- [Ideogram Text to Image](https://doitong.com/developers/models/ideogram/v3.md) (`ideogram/v3`): from $0.03 / image
- [Ideogram Object Removal](https://doitong.com/developers/models/ideogram/object-removal.md) (`ideogram/object-removal`): $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/v3/generate-transparent
- 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/generate-transparent
- Errors: https://doitong.com/developers/docs/errors
- Model details as JSON: https://api.doitong.com/v1/models/ideogram/v3/generate-transparent
