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

# Comfy Router で Ideogram 4.0 を使用する

> Comfy Router 経由で HTTP を使って Ideogram 4.0 で画像を生成するための Python、TypeScript、cURL スニペット、およびリクエストフィールドと結果の形状

Ideogram 4.0 の API リファレンス。Ideogram 4.0 は 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/ideogram-v4`

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

> [tab] 結果を待つ
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
> async def main():
>     async with AsyncComfy() as client:
>         result = await client.models.run(
>             "ideogram/ideogram-v4",
>             {
>                 "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
>                 "resolution": "1024x1024",
>                 "rendering_speed": "DEFAULT",
>             },
>         )
>
>     print("image:", result["data"][0]["url"])
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
> type Result = { data: { url: string }[] };
> const result = await comfy.models.run<Result>("ideogram/ideogram-v4", {
>   text_prompt: "a single red maple leaf on a plain white background, studio lighting",
>   resolution: "1024x1024",
>   rendering_speed: "DEFAULT",
> });
> if (result.kind !== "json") throw new Error("expected a JSON result");
>
> console.log("image:", result.data.data[0].url);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/ideogram/ideogram-v4 \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"text_prompt\": \"a single red maple leaf on a plain white background, studio lighting\", \"resolution\": \"1024x1024\", \"rendering_speed\": \"DEFAULT\"}"
> ```

> [tab] キューに送信して後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/ideogram/ideogram-v4/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/ideogram-v4",
>             {
>                 "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
>                 "resolution": "1024x1024",
>                 "rendering_speed": "DEFAULT",
>             },
>         )
>         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("image:", result["data"][0]["url"])
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
> type Result = { data: { url: string }[] };
> const handle = await comfy.models.submit<Result>("ideogram/ideogram-v4", {
>   text_prompt: "a single red maple leaf on a plain white background, studio lighting",
>   resolution: "1024x1024",
>   rendering_speed: "DEFAULT",
> });
> 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();
> if (result.kind !== "json") throw new Error("expected a JSON result");
>
> console.log("image:", result.data.data[0].url);
> ```
>
> ```bash cURL theme={null}
> # 1. 送信。Router は 201 と request_id、status_url、response_url、cancel_url を返します。
> curl https://api.comfy.org/v2/models/ideogram/ideogram-v4/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"text_prompt\": \"a single red maple leaf on a plain white background, studio lighting\", \"resolution\": \"1024x1024\", \"rendering_speed\": \"DEFAULT\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/ideogram/ideogram-v4/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集。200 はモデルのネイティブ出力、まだ実行中の場合は 202 とステータスボディを返します。
> curl https://api.comfy.org/v2/models/ideogram/ideogram-v4/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

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

生成後の著作権検出（Hive による類似性チェックとロゴチェック）を有効にします。

**json\_prompt** `object`

構造化された V4 プロンプト。Magic Prompt を無効化し、そのまま使用されます。text\_prompt または json\_prompt のいずれか一方のみを指定してください。

**rendering\_speed** `string` (default: "DEFAULT")

生成速度と品質のトレードオフを制御するレンダリング速度の設定

指定可能な値: `DEFAULT`、`TURBO`、`QUALITY`

**resolution** `string`

WIDTHxHEIGHT 形式の出力解像度。省略すると、モデルがアスペクト比を選択します。サポートされる 2K の値: 2048x2048, 1440x2880, 2880x1440, 1664x2496, 2496x1664, 1792x2240, 2240x1792, 1440x2560, 2560x1440, 1600x2560, 2560x1600, 1728x2304, 2304x1728, 1296x3168, 3168x1296, 1152x2944, 2944x1152, 1248x3328, 3328x1248, 1280x3072, 3072x1280。

**text\_prompt** `string`

自然言語のプロンプト。Magic Prompt が自動的に有効になります。text\_prompt または json\_prompt のいずれか一方のみを指定してください。

Router が `GET /v2/models/ideogram/ideogram-v4/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}
{
  "text_prompt": "a single red maple leaf on a plain white background, studio lighting",
  "resolution": "1024x1024",
  "rendering_speed": "DEFAULT"
}
```

### 出力

```json theme={null}
{
  "response_type": "url",
  "created": "2026-08-27T21:00:00Z",
  "data": [
    {
      "url": "https://.../image.png",
      "prompt": "a single red maple leaf on a plain white background, studio lighting",
      "resolution": "1024x1024",
      "seed": 1234567890,
      "is_image_safe": true
    }
  ]
}
```

URL は一時的なものです。画像を保持する必要がある場合は、速やかにダウンロードしてください。

## 出荷前の確認

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.