Use P Image Ideogram with Comfy Router

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

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/p-image-ideogram",
        {
            "prompt": "A beautiful mountain landscape",
        },
    )

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/p-image-ideogram", {
  prompt: "A beautiful mountain landscape",
});

console.log(data);

curl https://api.comfy.org/v2/models/ideogram/p-image-ideogram \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"prompt\": \"A beautiful mountain landscape\"}"

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.

boolean

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

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

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/p-image-ideogram/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 P Image Ideogram 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