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

# P Image Ideogram を Comfy Router で使用する

> Comfy Router 経由で ideogram/p-image-ideogram を呼び出す方法: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。

`ideogram/p-image-ideogram` の API リファレンスです。Comfy Router が Ideogram から提供しています。

**入力：** テキスト · **出力：** 画像

## クイックスタート

[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK を使用しており（`pip install comfy-sdk` と `npm install @comfyorg/sdk`）、cURL スニペットは同じ呼び出しを生の HTTP で行うものです。

**モデル ID:** `ideogram/p-image-ideogram`

**エンドポイント:** `POST https://api.comfy.org/v2/models/ideogram/p-image-ideogram`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
> 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";
>
> // 環境から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
> 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\"}"
> ```

> [tab] キューに送信して後で取得
>
> 同じボディを `POST https://api.comfy.org/v2/models/ideogram/p-image-ideogram/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は [キュー配信](https://docs.comfy.org/ja/development/comfy-router/queue.md) を参照してください。
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 環境から COMFY_API_KEY を読み取ります。
> # 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
> async def main():
>     async with AsyncComfy() as client:
>         handle = await client.models.submit(
>             "ideogram/p-image-ideogram",
>             {
>                 "prompt": "A beautiful mountain landscape",
>             },
>         )
>         print("request_id:", handle.request_id)  # モデル ID と合わせれば、別のプロセスに必要な情報はこれだけです
>
>         # サーバーが指定する Retry-After を待ちながら、リクエストが完了するまでポーリングします。
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # プロバイダー自身のペイロードで、models.run() が返す値と同じです。
>         # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境から COMFY_API_KEY を読み取ります。
> // 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
> const handle = await comfy.models.submit("ideogram/p-image-ideogram", {
>   prompt: "A beautiful mountain landscape",
> });
> console.log("requestId:", handle.requestId); // モデル ID と合わせれば、別のプロセスに必要な情報はこれだけです
>
> // サーバーが指定する Retry-After を待ちながら、リクエストが完了するまでポーリングします。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで reject されます。
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. 送信します。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
> curl https://api.comfy.org/v2/models/ideogram/p-image-ideogram/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"prompt\": \"A beautiful mountain landscape\"}"
>
> # 2. 各レスポンスが指定する Retry-After 秒を待ちながら、ステータスが COMPLETED になるまでポーリングします。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/ideogram/p-image-ideogram/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 取得します。モデルのネイティブ出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/ideogram/p-image-ideogram/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**aspect\_ratio** `string`

WxH 形式のアスペクト比。サポートされる値: 1x3、3x1、1x2、2x1、9x16、16x9、10x16、16x10、2x3、3x2、3x4、4x3、4x5、5x4、1x1。デフォルトは 1x1。

**enable\_copyright\_detection** `boolean`

生成後の著作権検出（Hive による類似性およびロゴのチェック）をオプトインします。

**prompt** `string` *required*

画像生成用のプロンプト。自然言語、または Ideogram 4.0 の JSON 構造化プロンプトのいずれかです。

**prompt\_upsampling** `string`

プロンプトのアップサンプリングモード。サポートされる値は AUTO、ON、OFF です。デフォルトは AUTO。

**quality** `string`

生成品質レベル。サポートされる値は VERY\_LOW、LOW、MEDIUM、HIGH です。デフォルトは MEDIUM。

**resolution** `string`

出力解像度。サポートされる値は 1K と 2K です。デフォルトは 1K。

**seed** `integer`

再現可能な生成のためのシード値

Router が `GET /v2/models/ideogram/p-image-ideogram/openapi.json` で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。

### 出力

**created** `string (date-time)`

生成が作成されたタイムスタンプ。

形式: `date-time`

**data** `object[]`

生成済み画像情報の配列。

**data\[].is\_image\_safe** `boolean`

画像が安全であると見なされるかどうかを示します。

**data\[].prompt** `string`

この画像の生成に使用されたプロンプト。

**data\[].resolution** `string`

生成済み画像の解像度（例: '1024x1024'）。

**data\[].seed** `integer`

この生成に使用されたシード値。

**data\[].style\_type** `string`

生成に使用されたスタイルタイプ（例: 'REALISTIC'、'ANIME'）。

**data\[].url** `string`

生成済み画像への URL。

## 例

### 入力

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

### 出力

```json theme={null}
{
  "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"
    }
  ]
}
```

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](https://docs.comfy.org/ja/development/comfy-router/reference.md#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](https://docs.comfy.org/ja/development/comfy-router/limitations.md) を参照してください。

このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ `comfy-sdk` / `@comfyorg/sdk` パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: `Comfy(api_key=...)` / `new Comfy({ apiKey })`、および `client.workflows`、`client.assets`、`client.jobs`。[Comfy SDKs](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.