> ## 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` ```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\"}" ``` 同じボディを `POST https://api.comfy.org/v2/models/ideogram/ideogram-4-5/requests` に送信します。Router は実行が受け付けられるとすぐに `201` と `request_id` を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集されます。[キュー配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、収集について説明します。 ```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="" 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" ``` ## スキーマ ### 入力 生成後の著作権検出をオプトインします。 1枚の画像を、Router が呼び出し元に代わって取得する https URL、またはバイト列をインラインで保持する `data:image/;base64,` URI のいずれかの形式で指定します。受け入れられる画像形式は png、webp、jpeg で、このセットはプロバイダーに委ねられるのではなく解決時に強制されます。つまり svg、gif、avif、tiff はここで拒否され、原因から2ホップ離れたパートナーエラーになるのではなく、送信した画像を名指しして通知されます。 URL 形式を推奨します。base64 ペイロードはおよそ 4/3 に膨らみ、リクエストボディ全体は 100 MiB に制限されるため、インライン形式ではソース画像が約 75 MB で頭打ちになります。URL ならこれを完全に回避できます。この説明の最後に記載されている画像ごとおよびリクエストごとのメディア上限はボディの上限よりも厳しいため、実サイズの画像ではまずこちらに当たります。 URL は認証情報なしで解決できなければなりません。Router はサーバー側で取得し、リクエストに呼び出し元の認証情報を一切付けません。そのため、署名がクエリ文字列に含まれる presigned 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 (`.r2.cloudflarestorage.com`、`pub-.r2.dev`)、Amazon S3 (`s3.amazonaws.com` および `s3..amazonaws.com`。path-style または `.` プレフィックス形式のいずれか)、Azure Blob Storage (`.blob.core.windows.net`)、Alibaba Cloud OSS (`.oss-.aliyuncs.com`。`oss-accelerate` エンドポイントを含む)。これらは具体的にはオブジェクトストレージのエンドポイントです。同じプロバイダードメイン上の汎用エンドポイント、たとえば Alibaba Function Compute のトリガーはリストに含まれず、拒否されます。 マッチングされるのはプロバイダーではなくホスト名の形式です。したがって上記でプロバイダー名を挙げたからといって、そのプロバイダーが発行しうるすべての URL が受け入れられるわけではありません。呼び出し元がそれぞれもっともらしく持ち込みうる、3つの惜しい例を明示しておきます。R2 のカスタムドメイン (`cdn.example.com`) は受け入れられません。Cloudflare は `pub-.r2.dev` をレート制限付きのデバッグ用ホスト名として文書化し、本番トラフィックは代わりにカスタムドメインへ向けるよう案内していますが、カスタムドメインのホスト名には R2 であることを示すものが何も含まれないため、Router は他のホストと区別できず拒否します。`.r2.cloudflarestorage.com` エンドポイントを presign するか、`pub-.r2.dev` 形式を使用してください。S3 の IPv6 dualstack エンドポイント (`s3.dualstack..amazonaws.com`) も受け入れられません。通常のリージョナルエンドポイントを使用してください。Azure Blob の代替 DNS ゾーン (`.z.blob.storage.azure.net`) も同様です。`.blob.core.windows.net` を使用してください。返される拒否メッセージにはこれらの同じ形式が記載されているので、ここに読みに来る必要はありません。 上記の `` と `pub-` のプレースホルダーは、通常持ち込む形式を示したものであり、階層の深さの制限ではありません。マッチングはオブジェクトストレージのドメインサフィックスに対して行われるため、同じ名前空間の下のより深い名前 (`a.b.pub-.r2.dev`) も受け入れられます。それによって広がるわけではないのは名前空間そのものです。サフィックスはいずれにせよ上記のいずれかでなければなりません。 以下の例は形状のみを示しています。実際の値には署名のクエリパラメータも含まれますが、公開された例はスペックに永遠に残り、実際の署名は漏洩した認証情報であると同時に機能しなくなるリンクでもあるため、ここでは意図的に省略しています。 各画像は 25 MiB、1つのリクエストの画像は合計 64 MiB が上限です。 生成操作の任意のソース画像。最初の1枚がプライマリソースで、残りは参照です。最大5枚、マスクありの場合は4枚です。 生成時のみ。テキストから画像へのプロンプト書き換え。サポートされる値は auto、on、off です。デフォルトは auto です。 1つの画像。呼び出し元に代わって Router が取得する https URL、またはバイトをインラインで含む `data:image/;base64,` 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` のような認証済みエンドポイントは、画像ではなく Router に 401 を返します。その 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（`.r2.cloudflarestorage.com`、`pub-.r2.dev`）、Amazon S3（`s3.amazonaws.com` および `s3..amazonaws.com`、パス形式または `.` を前置する形式のいずれか）、Azure Blob Storage（`.blob.core.windows.net`）、Alibaba Cloud OSS（`.oss-.aliyuncs.com`、`oss-accelerate` エンドポイントを含む）。これらは特にオブジェクトストレージのエンドポイントです。同じプロバイダードメイン上の汎用エンドポイント、たとえば Alibaba Function Compute のトリガーはリストになく、拒否されます。 一致するのはホスト名の形式であり、プロバイダーではありません。そのため、上記でプロバイダーを挙げることは、そのプロバイダーが発行できるすべての URL が受け入れられることを意味しません。3つの惜しい例は、呼び出し元がそれぞれを無理なく持ち込む可能性があるため、明確に述べておく価値があります。R2 のカスタムドメイン（`cdn.example.com`）は受け入れられません。Cloudflare は `pub-.r2.dev` をレート制限されたデバッグ用ホスト名として文書化し、本番トラフィックは代わりにカスタムドメインに向けますが、カスタムドメインはそのホスト名に R2 であることを示すものを何も含まないため、Router は他のホストと区別できず拒否します。`.r2.cloudflarestorage.com` エンドポイントに署名するか、`pub-.r2.dev` 形式を使用してください。S3 の IPv6 dualstack エンドポイント（`s3.dualstack..amazonaws.com`）も受け入れられません。通常のリージョンエンドポイントを使用してください。Azure Blob の代替 DNS ゾーン（`.z.blob.storage.azure.net`）も同様です。`.blob.core.windows.net` を使用してください。返される拒否メッセージにはこれらの同じ形式が示されるため、ここに来て読む必要はありません。 上記の `` と `pub-` のプレースホルダーは、通常持ち込む形式を示しています。深さの制限ではありません。マッチングはオブジェクトストレージのドメインサフィックスに対して行われます。そのため、同じ名前空間のより深い名前（`a.b.pub-.r2.dev`）も受け入れられます。それによって広がらないのは名前空間自体です。サフィックスは依然としてリストにあるものの1つでなければなりません。 以下の例は形状のみを示しています。実際の値は署名クエリパラメータも含みますが、公開された例は仕様に永遠に残り、実際の署名は漏洩した認証情報であると同時に機能しなくなるリンクでもあるため、ここでは意図的に省略しています。 各画像は 25 MiB に制限され、1つのリクエストの画像は合計 64 MiB に制限されます。 返す画像の数。それぞれが課金されます。 範囲: `1` から `8` 画像の指示または説明。1 から 10,000 文字。 品質ティア。これは課金レートでもあります。ソース画像ありの場合: very\_low、low、medium、または high（デフォルトは medium）。ソース画像なしの場合: low、medium、または high（デフォルトは high）。テキストから画像へのリクエストで very\_low は拒否されます。 指定可能な値: `very_low`、`low`、`medium`、`high` Precise Edit 用のオプションの参照画像。`image` が必要です。最大4枚、マスクありの場合は3枚まで。 再現可能な結果のためのシード。 範囲: `0` から `2147483647` 生成専用。出力サイズ。auto（デフォルト）、source（画像が必要）、または WIDTHxHEIGHT。マスクを送信する場合は省略してください。両方を設定したリクエストは拒否されます。 Router が `GET /v2/models/ideogram/ideogram-4-5/openapi.json` で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証する対象となるドキュメントと同じです。 ### 出力 生成済みの画像。 画像が安全と見なされるかどうかを示します。この値が true の画像のみを使用してください。 この画像の生成に使用されたプロンプト。 生成済み画像の解像度。 この画像に使用されたシード。 生成済み画像の URL。 生成の識別子。 この生成に使用されたシード。 ## 例 ### 入力 ```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 の有効期限](/ja/development/comfy-router/reference#結果アセット) があるため、早めにダウンロードしてください。 上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](/ja/development/comfy-router/limitations) を参照してください。 このページは、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](/ja/development/api-development/sdks) を参照してください。 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。 モデルの検出、バリデーションエラー、リトライ、課金。 Router が現在対応していないことと、代替手段。 This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.