> ## 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 4.0 with Comfy Router

> Python, TypeScript and cURL snippets for generating images with Ideogram 4.0 over HTTP through Comfy Router, plus the request fields and the result shape

API Reference for Ideogram 4.0. Ideogram 4.0 is Ideogram's text-to-image model, which renders legible text inside generated images.

<Note>
  **Comfy Router is not generally available yet.** `POST /v2/models/{provider}/{model}` and its catalog and schema siblings are not serving requests yet: an authenticated call answers `404` today. The snippets on this page document the contract those routes will serve, published ahead of the rollout so your integration is ready to write against.
</Note>

## Quick start

Create a key at [platform.comfy.org/profile/api-keys](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-v4`

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

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

  # Reads COMFY_API_KEY from the environment. Each call sends a fresh
  # Idempotency-Key and waits up to 10 minutes for the finished result.
  with Comfy() as client:
      result = client.models.run(
          "ideogram/ideogram-v4",
          {
              "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
              "resolution": "1024x1024",
              "rendering_speed": "DEFAULT",
          },
      )

  print("image:", result["data"][0]["url"])
  ```

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

  // Reads COMFY_API_KEY from the environment. Each call sends a fresh
  // Idempotency-Key and waits up to 10 minutes for the finished result.
  type Result = { data: { url: string }[] };
  const { data } = await comfy.models.run<Result>("ideogram/ideogram-v4", {
    text_prompt: "a single red maple leaf on a plain white background, studio lighting",
    resolution: "1024x1024",
    rendering_speed: "DEFAULT",
  });

  console.log("image:", data.data[0].url);
  ```

  ```bash cURL theme={null}
  curl https://api.comfy.org/v2/models/ideogram/ideogram-v4 \
    -H "X-API-Key: $COMFY_API_KEY" \
    -H "Idempotency-Key: $(uuidgen)" \
    -H "Content-Type: application/json" \
    -d "{\"text_prompt\": \"a single red maple leaf on a plain white background, studio lighting\", \"resolution\": \"1024x1024\", \"rendering_speed\": \"DEFAULT\"}"
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="enable_copyright_detection" type="boolean">
  Opt into post-generation copyright detection (Hive likeness and logo checks).
</ParamField>

<ParamField body="json_prompt" type="object">
  Structured V4 prompt. Disables Magic Prompt; consumed directly. Supply exactly one of text\_prompt or json\_prompt.
</ParamField>

<ParamField body="rendering_speed" type="string" 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">
  Output resolution in WIDTHxHEIGHT. Omit to let the model pick an aspect ratio. Supported 2K values: 2048x2048, 1440x2880, 2880x1440, 1664x2496, 2496x1664, 1792x2240, 2240x1792, 1440x2560, 2560x1440, 1600x2560, 2560x1600, 1728x2304, 2304x1728, 1296x3168, 3168x1296, 1152x2944, 2944x1152, 1248x3328, 3328x1248, 1280x3072, 3072x1280.
</ParamField>

<ParamField body="text_prompt" type="string">
  Natural-language prompt. Enables Magic Prompt automatically. Supply exactly one of text\_prompt or json\_prompt.
</ParamField>

Generated from the schema Router serves at `GET /v2/models/ideogram/ideogram-v4/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}
{
  "rendering_speed": "DEFAULT",
  "text_prompt": "A poster for a jazz festival, bold typography, warm colours"
}
```

### 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": "2048x2048",
      "seed": 918273645,
      "style_type": "REALISTIC",
      "url": "https://example.invalid/ideogram/ideogram-v4/generated.png"
    }
  ]
}
```

The URL is temporary. Download the image promptly if you need to keep it.

## Before you ship

The snippets above are the shortest working call. Three things are the same for every model and are documented once on the [Comfy Router headers](/development/comfy-router/headers) page: send an `Idempotency-Key` on every paid call and reuse it when you retry, expect the connection to be held up to Router's 10 minute deadline, and keep `X-Comfy-Request-Id` from every response. The SDKs do all three for you; the cURL tab does none of them. On failure, `X-Comfy-Error-Type` names the bucket, and a `422` means the body failed the model's schema and was never billed.

<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="Quick Start" icon="rocket" href="/development/comfy-router/quickstart">
    Typed error handling in Python and TypeScript, reading the 422, walking the catalog.
  </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>