> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-docs-router-model-page-pilot.mintlify.site/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

*Fields follow Ideogram's published API specification and are checked against it in CI. Router's own schema for this model is not published yet, so requests are forwarded to the provider unvalidated.*

<ParamField body="text_prompt" type="string">
  Text description of the image. Provide this or `json_prompt`.
</ParamField>

<ParamField body="json_prompt" type="object">
  Structured prompt, as an alternative to `text_prompt`.
</ParamField>

<ParamField body="resolution" type="string">
  Output size as `WIDTHxHEIGHT`, for example `1024x1024` or `1536x1024`.
</ParamField>

<ParamField body="rendering_speed" type="string" default="&#x22;DEFAULT&#x22;">
  Speed / quality trade-off.

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

<ParamField body="enable_copyright_detection" type="boolean">
  Reject outputs that match known copyrighted material.
</ParamField>

### Output

Router returns Ideogram's native response unchanged. The image is at `data[0].url`.

<ResponseField name="response_type" type="string">
  How the images are delivered.

  Possible values: `url`
</ResponseField>

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

  Format: `date-time`
</ResponseField>

<ResponseField name="data" type="object[]" required>
  Generated images.
</ResponseField>

<ResponseField name="data[].url" type="string (uri)">
  Temporary URL of the image. Download it promptly.

  Format: `uri`
</ResponseField>

<ResponseField name="data[].prompt" type="string" required>
  The prompt that was run.
</ResponseField>

<ResponseField name="data[].resolution" type="string" required>
  Output size as `WIDTHxHEIGHT`.
</ResponseField>

<ResponseField name="data[].seed" type="integer" required>
  Seed used for this image.
</ResponseField>

<ResponseField name="data[].is_image_safe" type="boolean" required>
  Whether the image passed Ideogram's safety filter.
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
  "resolution": "1024x1024",
  "rendering_speed": "DEFAULT"
}
```

### Output

```json theme={null}
{
  "response_type": "url",
  "created": "2026-08-27T21:00:00Z",
  "data": [
    {
      "url": "https://.../image.png",
      "prompt": "a single red maple leaf on a plain white background, studio lighting",
      "resolution": "1024x1024",
      "seed": 1234567890,
      "is_image_safe": true
    }
  ]
}
```

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="Quickstart" 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>