> ## 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.

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk`, `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`

<CodeGroup>
  ```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\"}"
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="aspect_ratio" type="string">
  Aspect ratio in format WxH
</ParamField>

<ParamField body="color_palette" type="object" />

<ParamField body="color_palette.members" type="object[]">
  Explicit colors with optional weights
</ParamField>

<ParamField body="color_palette.members[].color" type="string">
  Hexadecimal color code
</ParamField>

<ParamField body="color_palette.members[].weight" type="number">
  Optional weight for the color (0-1)

  Range: `0` to `1`
</ParamField>

<ParamField body="color_palette.name" type="string">
  Name of the color palette
</ParamField>

<ParamField body="magic_prompt" type="string">
  Whether to enable magic prompt enhancement

  Possible values: `AUTO`, `ON`, `OFF`
</ParamField>

<ParamField body="negative_prompt" type="string">
  Text prompt specifying what to avoid in the generation
</ParamField>

<ParamField body="num_images" type="integer">
  Number of images to generate

  Range: `1` to `…`
</ParamField>

<ParamField body="prompt" type="string" required>
  The text prompt for image generation
</ParamField>

<ParamField body="rendering_speed" type="string" required default="&#x22;DEFAULT&#x22;">
  The rendering speed setting that controls the trade-off between generation speed and quality

  Possible values: `DEFAULT`, `TURBO`, `QUALITY`
</ParamField>

<ParamField body="resolution" type="string">
  Image resolution in format WxH
</ParamField>

<ParamField body="seed" type="integer">
  Seed value for reproducible generation
</ParamField>

<ParamField body="style_codes" type="string[]">
  Array of style codes in hexadecimal format
</ParamField>

<ParamField body="style_type" type="string" default="&#x22;GENERAL&#x22;">
  Possible values: `AUTO`, `GENERAL`, `REALISTIC`, `DESIGN`, `FICTION`
</ParamField>

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

<ResponseField name="created" type="string (date-time)">
  Timestamp when the generation was created.

  Format: `date-time`
</ResponseField>

<ResponseField name="data" type="object[]">
  Array of generated image information.
</ResponseField>

<ResponseField name="data[].is_image_safe" type="boolean">
  Indicates whether the image is considered safe.
</ResponseField>

<ResponseField name="data[].prompt" type="string">
  The prompt used to generate this image.
</ResponseField>

<ResponseField name="data[].resolution" type="string">
  The resolution of the generated image (e.g., '1024x1024').
</ResponseField>

<ResponseField name="data[].seed" type="integer">
  The seed value used for this generation.
</ResponseField>

<ResponseField name="data[].style_type" type="string">
  The style type used for generation (e.g., 'REALISTIC', 'ANIME').
</ResponseField>

<ResponseField name="data[].url" type="string">
  URL to the generated image.
</ResponseField>

## 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. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/api">
    Model discovery, validation errors, retries, and billing.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>