Skip to main content
API Reference for ideogram/p-image-ideogram, served by Comfy Router from Ideogram.

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

Schema

Input

string
Aspect ratio in format WxH. Supported values: 1x3, 3x1, 1x2, 2x1, 9x16, 16x9, 10x16, 16x10, 2x3, 3x2, 3x4, 4x3, 4x5, 5x4, 1x1. Defaults to 1x1.
Opt into post-generation copyright detection (Hive likeness and logo checks).
string
required
The prompt for image generation, either natural language or an Ideogram 4.0 JSON structured prompt.
string
Prompt upsampling mode. Supported values are AUTO, ON, and OFF. Defaults to AUTO.
string
Generation quality level. Supported values are VERY_LOW, LOW, MEDIUM, and HIGH. Defaults to MEDIUM.
string
Output resolution. Supported values are 1K and 2K. Defaults to 1K.
integer
Seed value for reproducible generation
Generated from the schema Router serves at GET /v2/models/ideogram/p-image-ideogram/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

Router does not publish an output schema for this model.

Examples

Input

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.

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.