> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Ideogram V3 with Comfy Router

> Call ideogram/ideogram-v3 through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `ideogram/ideogram-v3`, served by Comfy Router from Ideogram.

**Input:** Text · **Output:** Image

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys?onboarding=router) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk` and `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `ideogram/ideogram-v3`

**Endpoint:** `POST https://api.comfy.org/v2/models/ideogram/ideogram-v3`

**Wait for the result**

```python Python theme={null}
from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "ideogram/ideogram-v3",
        {
            "prompt": "A beautiful mountain landscape",
            "rendering_speed": "TURBO",
        },
    )

print(result)
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// The SDK automatically creates an idempotency key and reuses it for automatic retries.
const { data } = await comfy.models.run("ideogram/ideogram-v3", {
  prompt: "A beautiful mountain landscape",
  rendering_speed: "TURBO",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/ideogram/ideogram-v3 \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"prompt\": \"A beautiful mountain landscape\", \"rendering_speed\": \"TURBO\"}"
```

**Queue and collect later**

The same body, sent to `POST https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](https://docs.comfy.org/development/comfy-router/queue.md) walks through status, cancellation and collection.

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# Reads COMFY_API_KEY from the environment.
# Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "ideogram/ideogram-v3",
            {
                "prompt": "A beautiful mountain landscape",
                "rendering_speed": "TURBO",
            },
        )
        print("request_id:", handle.request_id)  # with the model ID, all another process needs

        # Poll until the request completes, waiting the Retry-After the server names.
        async for update in handle.iter_events():
            print(update.status, update.queue_position)

        # The provider's own payload, the same value models.run() returns.
        # A request that failed or was cancelled raises the typed Router error here.
        result = await handle.get()

    print(result)

asyncio.run(main())
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// Reads COMFY_API_KEY from the environment.
// Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
const handle = await comfy.models.submit("ideogram/ideogram-v3", {
  prompt: "A beautiful mountain landscape",
  rendering_speed: "TURBO",
});
console.log("requestId:", handle.requestId); // with the model ID, all another process needs

// Poll until the request completes, waiting the Retry-After the server names.
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// The same result models.run() returns. A request that failed or was cancelled rejects here.
const result = await handle.get();

console.log(result.data);
```

```bash cURL theme={null}
# 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
curl https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"prompt\": \"A beautiful mountain landscape\", \"rendering_speed\": \"TURBO\"}"

# 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
curl https://api.comfy.org/v2/models/ideogram/ideogram-v3/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## Schema

### Input

**aspect\_ratio** `string`

Aspect ratio in format WxH

**color\_palette** `object`

**color\_palette.members** `object[]`

Explicit colors with optional weights

**color\_palette.members\[].color** `string`

Hexadecimal color code

**color\_palette.members\[].weight** `number`

Optional weight for the color (0-1)

Range: `0` to `1`

**color\_palette.name** `string`

Name of the color palette

**magic\_prompt** `string`

Whether to enable magic prompt enhancement

Possible values: `AUTO`, `ON`, `OFF`

**negative\_prompt** `string`

Text prompt specifying what to avoid in the generation

**num\_images** `integer`

Number of images to generate

Range: `1` to `…`

**prompt** `string` *required*

The text prompt for image generation

**rendering\_speed** `string` *required* (default: "DEFAULT")

The rendering speed setting that controls the trade-off between generation speed and quality

Possible values: `DEFAULT`, `TURBO`, `QUALITY`

**resolution** `string`

Image resolution in format WxH

**seed** `integer`

Seed value for reproducible generation

**style\_codes** `string[]`

Array of style codes in hexadecimal format

**style\_type** `string` (default: "GENERAL")

Possible values: `AUTO`, `GENERAL`, `REALISTIC`, `DESIGN`, `FICTION`

Generated from the schema Router serves at `GET /v2/models/ideogram/ideogram-v3/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

**created** `string (date-time)`

Timestamp when the generation was created.

Format: `date-time`

**data** `object[]`

Array of generated image information.

**data\[].is\_image\_safe** `boolean`

Indicates whether the image is considered safe.

**data\[].prompt** `string`

The prompt used to generate this image.

**data\[].resolution** `string`

The resolution of the generated image (e.g., '1024x1024').

**data\[].seed** `integer`

The seed value used for this generation.

**data\[].style\_type** `string`

The style type used for generation (e.g., 'REALISTIC', 'ANIME').

**data\[].url** `string`

URL to the generated image.

## Examples

### Input

```json theme={null}
{
  "prompt": "A beautiful mountain landscape",
  "rendering_speed": "TURBO"
}
```

### Output

```json theme={null}
{
  "created": "2026-01-01T00:00:00Z",
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A poster for a jazz festival, bold typography, warm colours",
      "resolution": "1024x1024",
      "seed": 918273645,
      "style_type": "REALISTIC",
      "url": "https://example.invalid/ideogram/ideogram-v3/generated.png"
    }
  ]
}
```

## Before you ship

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. A `422` means Router rejected the input before calling the provider, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](https://docs.comfy.org/development/comfy-router/reference.md#result-assets).

Any size limit named in a field description above is the provider's own bound on that field, quoted from the provider's specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see [request body size](https://docs.comfy.org/development/comfy-router/limitations.md#request-bodies-are-capped).

This page documents one partner model called through Comfy Router. The same `comfy-sdk` / `@comfyorg/sdk` package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, with `client.workflows`, `client.assets` and `client.jobs`. See [Comfy SDKs](https://docs.comfy.org/development/api-development/sdks.md).

> **[Headers](https://docs.comfy.org/development/comfy-router/headers.md)**
>
> Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

> **[Using the Router API](https://docs.comfy.org/development/comfy-router/api.md)**
>
> Model discovery, validation errors, retries, and billing.

> **[Limitations](https://docs.comfy.org/development/comfy-router/limitations.md)**
>
> What Router does not do today, and what to use instead.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.