> ## 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.5 を使用する

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

`ideogram/ideogram-4-5` の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 のスニペットは、同じ呼び出しを raw HTTP で行うものです。

**Model ID:** `ideogram/ideogram-4-5`

**Endpoint:** `POST https://api.comfy.org/v2/models/ideogram/ideogram-4-5`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "ideogram/ideogram-4-5",
>         {
>             "prompt": "A poster for a jazz festival, bold typography, warm colours",
>             "quality": "low",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
> const { data } = await comfy.models.run("ideogram/ideogram-4-5", {
>   prompt: "A poster for a jazz festival, bold typography, warm colours",
>   quality: "low",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/ideogram/ideogram-4-5 \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"prompt\": \"A poster for a jazz festival, bold typography, warm colours\", \"quality\": \"low\"}"
> ```

> [tab] キューに送信して後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/ideogram/ideogram-4-5/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-4-5",
>             {
>                 "prompt": "A poster for a jazz festival, bold typography, warm colours",
>                 "quality": "low",
>             },
>         )
>         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/ideogram-4-5", {
>   prompt: "A poster for a jazz festival, bold typography, warm colours",
>   quality: "low",
> });
> 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 は 201 とともに request_id、status_url、response_url、cancel_url を返します。
> curl https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"prompt\": \"A poster for a jazz festival, bold typography, warm colours\", \"quality\": \"low\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集します。200 ならモデルのネイティブ出力、まだ実行中なら 202 とステータスボディが返ります。
> curl https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**context\_window** `string`

Precise Edit 専用。`image` が必要です。編集が対象とするソース画像内の領域です。これにより、非常に大きな画像でも1か所だけを編集し、残りをそのままにした状態でフルサイズで返すことができます。`none`（デフォルト）は画像全体を編集します。`auto` は `mask` の周囲に領域を合わせ、`mask` が必須になります。それ以外の場合は `y_min,x_min,y_max,x_max` を4つの非負の整数によるピクセル境界として送信します。`y_max` は `y_min` より大きく、`x_max` は `x_min` より大きく、各辺は最低 256 ピクセル、アスペクト比は 1:6 から 6:1 の間、面積は最大 4,194,304 ピクセルです。`image` のないリクエストで `none` 以外の値を指定すると拒否されます。`context_window` はコンテキストウィンドウのゲートが有効な場合にのみ受け付けられます。有効でない場合、`none` 以外の値は 422 で拒否されます。

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

生成後の著作権検出を有効にします。

**image** `string`

1枚の画像を、呼び出し元の代わりに Router が取得する https URL、またはバイト列をインラインで含む `data:image/<format>;base64,<payload>` URI のいずれかで指定します。受け付けられる画像形式は png、webp、jpeg で、この組み合わせはプロバイダーに委ねるのではなく解決時に強制されます。svg、gif、avif、tiff はここで拒否され、送信した画像名が示されます。原因から2ホップ離れたパートナーエラーになることはありません。
URL 形式を推奨します。base64 ペイロードは約 4/3 に膨らみ、リクエスト本文全体は 100 MiB に制限されるため、インライン形式ではソース画像が約 75 MB で上限に達します。URL ならこれを完全に回避できます。この説明の最後に記載する画像ごとおよびリクエストごとのメディア上限は本文の上限より厳しいため、実際のサイズの画像ではまずそちらに達します。
URL はあなたの認証情報なしで解決できる必要があります。Router はサーバー側で取得し、リクエストに呼び出し元の認証情報を含めません。そのため、署名がクエリ文字列に含まれる形式の署名付き URL がサポートされる形式です。`/api/assets/{id}/content` のような認証が必要なエンドポイントは、画像ではなく 401 を Router に返します。その URL はご自身でリクエストし、リダイレクト先の署名付き URL を渡してください。
取得は開かれたインターネットではなく、名前を挙げたホスト群に限定されます。同じリストは、送信した URL だけでなくすべてのリダイレクト先にも再適用されます。そのため、他のホストの URL や、リスト外へリダイレクトする URL は、どのプロバイダーにも接続する前に拒否されます。現在このリストは Comfy 自身のアセット配信のみです。Comfy のアセットバケット配下の署名付き `storage.googleapis.com` URL で、これは `/api/assets/{id}/content` がリダイレクトする形式です。パートナー CDN や通常の https ホストはリストに含まれません。
2つの拡張が展開中で、いずれも現在はデフォルトで無効です。これらは1つの切り替えの背後で提供され、一緒に有効になります。したがって、以下はまだ実装の前提とせず、今後提供予定のものとして扱ってください。どちらかに依存する前にご確認ください。
1つ目は、`POST /customers/storage` がアップロード先として署名するバケットです。展開があなたの環境に届くまで、そのエンドポイントから得たアップロード URL はここで拒否されます。バケットは Comfy 自身のものでホストも同じであっても変わりません。そのため「Comfy にアップロードしてから URL を渡す」はまだ動作せず、動作するのは `/api/assets/{id}/content` がリダイレクトする署名付き URL の形式です。
2つ目は全員に一度にではなくアカウントごとに有効になります。これらのホストの背後にあるバケットは当社ではなくあなたのものだからです。上記の切り替えがオンになっても、サードパーティの受信メディアが有効化されていないアカウントは拒否され、ホストが非対応であるというのではなく、その旨がそのまま伝えられます。お使いのアカウントで有効にするよう Comfy の担当者に依頼してください。さらに、以下のサードパーティのオブジェクトストレージホストが許可されます。ここではバケットはあなたのものであり、Router は所有権を主張しません。Cloudflare R2（`<account>.r2.cloudflarestorage.com`、`pub-<hash>.r2.dev`）、Amazon S3（`s3.amazonaws.com` および `s3.<region>.amazonaws.com`、パス形式または `<bucket>.` 接頭辞形式のいずれか）、Azure Blob Storage（`<account>.blob.core.windows.net`）、Alibaba Cloud OSS（`<bucket>.oss-<region>.aliyuncs.com`、`oss-accelerate` エンドポイントを含む）。これらは特にオブジェクトストレージのエンドポイントです。同じプロバイダードメイン上の汎用エンドポイント（Alibaba Function Compute のトリガーなど）はリストに含まれず、拒否されます。
照合されるのはプロバイダーではなくホスト名の形式です。したがって、上でプロバイダー名を挙げたからといって、そのプロバイダーが発行できるすべての URL が受け入れられるわけではありません。呼び出し元が妥当にたどり着きうる3つの惜しい例を明示しておきます。R2 のカスタムドメイン（`cdn.example.com`）は受け入れられません。Cloudflare は `pub-<hash>.r2.dev` をレート制限付きのデバッグ用ホスト名として文書化し、本番トラフィックは代わりにカスタムドメインに向けるよう案内していますが、カスタムドメインのホスト名には R2 であることを示すものが何もないため、Router は他のホストと区別できず拒否します。`<account>.r2.cloudflarestorage.com` エンドポイントを署名するか、`pub-<hash>.r2.dev` 形式を使用してください。S3 の IPv6 dualstack エンドポイント（`s3.dualstack.<region>.amazonaws.com`）も受け入れられません。通常のリージョナルエンドポイントを使用してください。Azure Blob の代替 DNS ゾーン（`<account>.z<N>.blob.storage.azure.net`）も同様です。`<account>.blob.core.windows.net` を使用してください。返される拒否メッセージには同じ形式が示されるため、それらを読むためにここへ戻る必要はありません。
上記の `<account>` と `pub-<hash>` というプレースホルダーは、通常たどり着く形式を示すものであり、階層の深さの制限ではありません。照合はオブジェクトストレージのドメインサフィックスに対して行われるため、同じ名前空間のより深い名前（`a.b.pub-<hash>.r2.dev`）も受け入れられます。ただし、これによって広がるのは名前空間そのものではありません。サフィックスは依然として列挙されたもののいずれかである必要があります。
以下の例は形状のみを示しています。実際の値には署名のクエリパラメータも含まれますが、公開された例は仕様に永久に残り、実際の署名は認証情報の漏えいであると同時に機能しなくなるリンクでもあるため、ここでは意図的に省略しています。
画像1枚あたり 25 MiB、1リクエストの画像は合計 64 MiB が上限です。唯一の例外は ideogram/ideogram-4-5 Precise Edit（`image` を送る呼び出し）で `context_window` が利用できる場合です。そこでは各画像が最大 50 MB（50,000,000 バイト）かつ 67,108,864 ピクセル、1リクエストの画像は合計 128 MiB までです。

**images** `string[]`

生成操作用の任意のソース画像です。1枚目が主要なソースで、残りは参照です。最大5枚、マスクを使う場合は4枚です。

**magic\_prompt** `string`

生成時のみ。テキストから画像へのプロンプト書き換えです。サポートされる値は auto、on、off です。デフォルトは auto です。

**mask** `string`

画像1枚を、呼び出し元の代わりに Router が取得する https URL、またはバイト列をインラインで含む `data:image/<format>;base64,<payload>` URI のいずれかで指定します。受け付ける画像形式は png、webp、jpeg で、この組み合わせはプロバイダーに委ねるのではなく解決時に強制されます。svg、gif、avif、tiff はここで拒否され、送信した画像を名指しで示します。原因から2ホップ離れたパートナーのエラーにはなりません。
URL 形式を推奨します。base64 ペイロードは約 4/3 に膨張し、リクエストボディ全体は 100 MiB が上限なので、インライン形式ではソース画像が概ね 75 MB のあたりで上限に達します。URL ならこれを完全に回避できます。この説明の末尾に示す画像あたり・リクエストあたりのメディア上限はボディの上限より厳しいため、実サイズの画像ではまずそちらに当たります。
URL は認証情報なしで解決できなければなりません。Router はサーバー側で取得し、呼び出し元の認証情報をリクエストに含めません。そのため、署名がクエリ文字列に入っているプレサインド URL がサポートされる形式です。`/api/assets/{id}/content` のような認証が必要なエンドポイントは、画像ではなく 401 を Router に返します。その URL はご自身でリクエストし、リダイレクト先の署名付き URL を渡してください。
取得は開かれたインターネットではなく、名前を挙げたホスト群に限定されます。同じリストは、送信した URL だけでなく各リダイレクトホップにも再適用されます。したがって、それ以外のホストの URL や、リスト外へリダイレクトする URL は、プロバイダーに接触する前に拒否されます。現時点でそのリストは Comfy 自身のアセット配信のみです。Comfy のアセットバケット配下の署名付き `storage.googleapis.com` URL で、これが `/api/assets/{id}/content` のリダイレクト先となる形式です。パートナーの CDN や通常の https ホストはリストに含まれません。
2つの拡張がロールアウト中で、どちらも現時点ではデフォルトで無効です。これらは1つの切り替えの背後で提供され、まとめて有効になります。そのため以下はすべて将来のものとして扱い、まだ前提に組み込まないでください。どちらかに依存する前に確認してください。
1つ目は `POST /customers/storage` がアップロード先として署名するバケットです。ロールアウトがお使いの環境に届くまで、そのエンドポイントが発行するアップロード URL はここで拒否されます。バケットが Comfy 自身のものでホストも同じであってもです。つまり「Comfy にアップロードしてから URL を渡す」はまだ機能せず、機能するのは `/api/assets/{id}/content` がリダイレクトする署名付き URL の形式です。
2つ目は全員一斉ではなくアカウント単位で有効になります。これらのホストの背後にあるバケットは当社ではなくお客様のものだからです。上記の切り替えがオンになっていても、サードパーティのインバウンドメディアが有効化されていないアカウントは拒否され、ホストが非対応だとは言われず、その旨がそのまま伝えられます。お使いのアカウントで有効にするよう Comfy の担当者に依頼してください。さらに次のサードパーティのオブジェクトストレージホストを許可します。バケットはお客様のものであり、Router はそれに対する所有権を主張しません: Cloudflare R2（`<account>.r2.cloudflarestorage.com`、`pub-<hash>.r2.dev`）、Amazon S3（`s3.amazonaws.com` および `s3.<region>.amazonaws.com`、パス形式または `<bucket>.` 前置き形式のいずれか）、Azure Blob Storage（`<account>.blob.core.windows.net`）、Alibaba Cloud OSS（`<bucket>.oss-<region>.aliyuncs.com`、`oss-accelerate` エンドポイントを含む）。これらはあくまでオブジェクトストレージのエンドポイントです。同じプロバイダーのドメイン上の汎用エンドポイント、たとえば Alibaba Function Compute のトリガーはリストになく拒否されます。
照合されるのはプロバイダーではなくホスト名の形式です。したがって上でプロバイダーを挙げたからといって、そのプロバイダーが発行しうるすべての URL が受け入れられるわけではありません。呼び出し元が妥当に辿り着きうる3つの惜しい形式を明示しておきます。R2 のカスタムドメイン（`cdn.example.com`）は受け入れられません。Cloudflare は `pub-<hash>.r2.dev` をレート制限のあるデバッグ用ホスト名として文書化し、本番トラフィックはカスタムドメインに向けるよう案内していますが、カスタムドメインのホスト名には R2 であることを示す情報がないため、Router は他のホストと区別できず拒否します。`<account>.r2.cloudflarestorage.com` エンドポイントをプレサインドするか、`pub-<hash>.r2.dev` 形式を使用してください。S3 の IPv6 dualstack エンドポイント（`s3.dualstack.<region>.amazonaws.com`）も受け入れられません。通常のリージョン別エンドポイントを使用してください。Azure Blob の別名 DNS ゾーン（`<account>.z<N>.blob.storage.azure.net`）も同様です。`<account>.blob.core.windows.net` を使用してください。返される拒否メッセージには同じ形式が示されるため、ここに戻って読む必要はありません。
上記の `<account>` と `pub-<hash>` のプレースホルダーは、通常用いる形式を示すものであって、階層の深さの制限ではありません。照合はオブジェクトストレージのドメインサフィックスに対して行われるため、同じ名前空間のより深い名前（`a.b.pub-<hash>.r2.dev`）も受け入れられます。ただし名前空間自体が広がるわけではなく、サフィックスは一覧にあるもののいずれかでなければなりません。
以下の例は形状のみを示しています。実際の値には署名のクエリパラメータも付きますが、ここでは意図的に省略しています。公開された例は仕様の中に永久に残り、実際の署名は漏えいした認証情報であると同時に、やがて機能しなくなるリンクでもあるからです。各画像は 25 MiB、1 回のリクエストの画像は合計 64 MiB までです。唯一の例外は ideogram/ideogram-4-5 Precise Edit（`image` を送信する呼び出し）で `context_window` が利用できる場合です。その場合は各画像が最大 50 MB（50,000,000 バイト）かつ 67,108,864 ピクセルまで、1 回のリクエストの画像は合計 128 MiB までとなります。

**num\_images** `integer` (default: 1)

返す画像の数です。各画像が課金対象になります。

範囲: `1` から `8`

**prompt** `string` *required*

画像に対する指示または説明で、1 から 10,000 文字です。

**quality** `string`

品質ティアであり、課金レートでもあります。ソース画像がある場合: very\_low、low、medium、high（デフォルトは medium）。ソース画像がない場合: low、medium、high（デフォルトは high）。テキストから画像へのリクエストで very\_low は拒否されます。

可能な値: `very_low`、`low`、`medium`、`high`

**reference\_images** `string[]`

Precise Edit 用のオプションの参照画像です。`image` が必要です。最大 4 枚、マスクを使用する場合は 3 枚までです。

**seed** `integer`

再現可能な結果を得るためのシードです。

範囲: `0` から `2147483647`

**size** `string`

生成時のみ。出力サイズです。auto（デフォルト）、source（画像が必要）、または WIDTHxHEIGHT。マスクを送信する場合は省略してください。両方を設定したリクエストは拒否されます。

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

### 出力

**data** `object[]`

生成された画像。

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

画像が安全と見なされるかどうかを示します。この値が true の画像のみを使用してください。

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

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

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

生成された画像の解像度。

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

この画像に使用されたシード。

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

生成された画像への URL。

**generation\_id** `string`

生成の識別子。

**seed** `integer`

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

## 例

### 入力

```json theme={null}
{
  "prompt": "A poster for a jazz festival, bold typography, warm colours",
  "quality": "low"
}
```

### 出力

```json theme={null}
{
  "data": [
    {
      "is_image_safe": true,
      "prompt": "A poster for a jazz festival, bold typography, warm colours",
      "resolution": "2048x2048",
      "seed": 918273645,
      "url": "https://example.invalid/ideogram/ideogram-4-5/generated.png"
    }
  ],
  "generation_id": "gen_0123456789",
  "seed": 918273645
}
```

## 出荷前の確認

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.