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 asCOMFY_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
boolean
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, QUALITYstring
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.
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-timeobject[]
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
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 anIdempotency-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.
Quick Start
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.