クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk および npm install @comfyorg/sdk)を使用します。cURL スニペットは同じ呼び出しを生の HTTP で行うものです。
呼び出したいモデルを選択してください。以下の内容(スニペット、スキーマ、例)はすべて選択したモデルに対応しています。
- FLUX 1.1 [pro] Ultra
- FLUX 1.1 [pro]
モデル ID: URL は一時的なものです。保存が必要な場合は、速やかに画像をダウンロードしてください。
bfl/flux-pro-1.1-ultraエンドポイント: POST https://api.comfy.org/v2/models/bfl/flux-pro-1.1-ultra- 結果を待つ
- キューに送信して後で収集
同じ本文を
POST https://api.comfy.org/v2/models/bfl/flux-pro-1.1-ultra/requests に送信します。Router は実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備が整い次第、このプロセスからでも別のプロセスからでも収集できます。ステータス、キャンセル、収集の詳細は キュー配信 を参照してください。スキーマ
入力
GET /v2/models/bfl/flux-pro-1.1-ultra/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証するのと同じドキュメントです。出力
完了した生成結果。ここでは null 許容ではありません。このコンポーネントの
required エントリは、200 が結果を伴うことを約束するものであり、result を null 許容にするとキーの存在確認にまで後退してしまいます。生成されたアセットの署名付き URL。Router はアセットを Comfy ストレージに再ホストしてこのフィールドを書き換えるため、通常は最大 24 時間有効な Comfy ホストの URL になります。発行時点で 24 時間の署名が付き、23 時間のメモから再生されるため、後からのポーリングでは残り 1 時間しかない URL が返されることもあります。再ホストを実行できなかったリーフは、代わりに BFL 自身の短命な配信 URL を保持します(ビデオで約 2 時間、画像で約 10 分)。いずれにしてもリンクは期限切れになるため、URL を保存するのではなくアセットをダウンロードしてください。形式:
uri生成で使用されたシード。指定されたものか、プロバイダーが選択したものかは問いません。
int64 と宣言されているのは、BFL が 2^31 を超えるシード(例: 2784347701)を返すためです。フォーマットされていない integer は、多くの SDK ジェネレーターで 32 ビットフィールドとして生成されます。形式: int64プロバイダーが報告する生成の開始時刻(Unix エポックからの秒数)。
double であり float ではありません。現在のエポック値付近における float32 の間隔は約 128 秒で、生成全体のスパンが単一のデコード値に潰れてしまいます。形式: doubleタスクのステータス: Pending、Reasoning、Generating、Ready、Request Moderated、Content Moderated、Error、または Task not found。
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。
このページは、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 を参照してください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。