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

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-v4 Endpoint: POST https://api.comfy.org/v2/models/ideogram/ideogram-v4

Schema

Input

Opt into post-generation copyright detection (Hive likeness and logo checks).
object
Structured V4 prompt. Disables Magic Prompt; consumed directly. Supply exactly one of text_prompt or json_prompt.
string
default:"\"DEFAULT\""
The rendering speed setting that controls the trade-off between generation speed and qualityPossible values: DEFAULT, TURBO, QUALITY
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.
string
Natural-language prompt. Enables Magic Prompt automatically. Supply exactly one of text_prompt or json_prompt.
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

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

Output

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

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.