Use Ideogram V3 with Comfy Router

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

Quick start

Create a key in your Comfy workspace 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

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)

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);

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\"}"

Schema

Input

string

Aspect ratio in format WxH

object

object[]

Explicit colors with optional weights

string

Hexadecimal color code

number

Optional weight for the color (0-1)Range: 0 to 1

string

Name of the color palette

string

Whether to enable magic prompt enhancementPossible values: AUTO, ON, OFF

string

Text prompt specifying what to avoid in the generation

integer

Number of images to generateRange: 1 to …

string

required

The text prompt for image generation

string

default:"\"DEFAULT\""

required

The rendering speed setting that controls the trade-off between generation speed and qualityPossible values: DEFAULT, TURBO, QUALITY

string

Image resolution in format WxH

integer

Seed value for reproducible generation

string[]

Array of style codes in hexadecimal format

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

string (date-time)

Timestamp when the generation was created.Format: date-time

object[]

Array of generated image information.

boolean

Indicates whether the image is considered safe.

string

The prompt used to generate this image.

string

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

integer

The seed value used for this generation.

string

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

string

URL to the generated image.

Examples

Input

{
  "prompt": "A beautiful mountain landscape",
  "rendering_speed": "TURBO"
}

Output

{
  "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.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.

Develop with Comfy

Deploy ComfyUI

Run Workflows

Comfy Router

Comfy CLI

Specifications

Use Ideogram V3 with Comfy Router

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship

Headers

Using the Router API

Limitations

​Quick start

​Schema

​Input

​Output

​Examples

​Input

​Output

​Before you ship

Headers

Using the Router API

Limitations

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship