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

Quick start

Create a key at 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

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.
string
Text description of the image. Provide this or json_prompt.
object
Structured prompt, as an alternative to text_prompt.
string
Output size as WIDTHxHEIGHT, for example 1024x1024 or 1536x1024.
string
default:"\"DEFAULT\""
Speed / quality trade-off.Possible values: TURBO, BALANCED, DEFAULT, QUALITY
Reject outputs that match known copyrighted material.

Output

Router returns Ideogram’s native response unchanged. The image is at data[0].url.
string
How the images are delivered.Possible values: url
string (date-time)
required
Timestamp of the generation.Format: date-time
object[]
required
Generated images.
string (uri)
Temporary URL of the image. Download it promptly.Format: uri
string
required
The prompt that was run.
string
required
Output size as WIDTHxHEIGHT.
integer
required
Seed used for this image.
boolean
required
Whether the image passed Ideogram’s safety filter.

Examples

Input

Output

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

Headers

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

Quickstart

Typed error handling in Python and TypeScript, reading the 422, walking the catalog.

Limitations

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