> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Use P Image Ideogram with Comfy Router

> Call ideogram/p-image-ideogram through Comfy Router: endpoint, request shape and the response Router returns.

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](https://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`

<CodeGroup>
  ```python Python theme={null}
  from comfy_sdk import Comfy

  # Reads COMFY_API_KEY from the environment. Each call sends a fresh
  # Idempotency-Key and waits up to 10 minutes for the finished result.
  with Comfy() as client:
      result = client.models.run(
          "ideogram/p-image-ideogram",
          {
              "prompt": "A beautiful mountain landscape",
          },
      )

  print(result)
  ```

  ```typescript TypeScript theme={null}
  import { comfy } from "@comfyorg/sdk";

  // Reads COMFY_API_KEY from the environment. Each call sends a fresh
  // Idempotency-Key and waits up to 10 minutes for the finished result.
  const { data } = await comfy.models.run("ideogram/p-image-ideogram", {
    prompt: "A beautiful mountain landscape",
  });

  console.log(data);
  ```

  ```bash cURL theme={null}
  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\"}"
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="aspect_ratio" type="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.
</ParamField>

<ParamField body="enable_copyright_detection" type="boolean">
  Opt into post-generation copyright detection (Hive likeness and logo checks).
</ParamField>

<ParamField body="prompt" type="string" required>
  The prompt for image generation, either natural language or an Ideogram 4.0 JSON structured prompt.
</ParamField>

<ParamField body="prompt_upsampling" type="string">
  Prompt upsampling mode. Supported values are AUTO, ON, and OFF. Defaults to AUTO.
</ParamField>

<ParamField body="quality" type="string">
  Generation quality level. Supported values are VERY\_LOW, LOW, MEDIUM, and HIGH. Defaults to MEDIUM.
</ParamField>

<ParamField body="resolution" type="string">
  Output resolution. Supported values are 1K and 2K. Defaults to 1K.
</ParamField>

<ParamField body="seed" type="integer">
  Seed value for reproducible generation
</ParamField>

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

```json theme={null}
{
  "prompt": "A beautiful mountain landscape"
}
```

## 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](/development/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.

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Quick Start" icon="rocket" href="/development/comfy-router/quickstart">
    Typed error handling in Python and TypeScript, reading the 422, walking the catalog.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>