クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用します。cURL のスニペットは、生の HTTP で同じ呼び出しを行うものです。
呼び出したいモデルを選択してください。以下の内容はすべて、スニペットからスキーマ、例に至るまで、この選択に従います。
- Kontext Pro
- Kontext Max
モデル ID: URL は一時的なものです。画像を保持する必要がある場合は、速やかにダウンロードしてください。
bfl/flux-kontext-proエンドポイント: POST https://api.comfy.org/v2/models/bfl/flux-kontext-pro- Wait for the result
- Queue and collect later
スキーマ
入力
string
出力のアスペクト比で、21:9 から 9:21 の間(例: 16:9)。入力画像が指定されている場合はその入力画像のアスペクト比がデフォルトになり、それ以外の場合は 1:1 になります。
string
編集する画像。base64 でエンコードされた画像、または http(s) URL として指定します。オプションです。指定しない場合、モデルはプロンプトのみから生成します。
string
追加の参照画像。base64 でエンコードされた画像、または http(s) URL(実験的なマルチリファレンス)。
string
追加の参照画像。base64 でエンコードされた画像、または http(s) URL(実験的なマルチリファレンス)。
string
追加の参照画像。base64 でエンコードされた画像、または http(s) URL(実験的なマルチリファレンス)。
string
デフォルト:"\"png\""
出力画像形式。指定可能な値:
jpeg、png、webpstring
必須
input_image に適用する編集、または input_image が指定されていない場合に生成する画像を記述するテキストプロンプト。
boolean
デフォルト:"false"
プロンプトをアップサンプリングするかどうか。有効にすると、より創造的な生成のためにプロンプトが自動的に変更されます。
integer
デフォルト:"2"
入力と出力のモデレーションの許容値レベル。0(最も厳格)から 6(最も緩い)の間。範囲:
0 から 6integer
再現性のためのオプションのシード。省略した場合はランダムなシードが使用されます。
string
webhook 署名検証用のオプションのシークレット。
string (uri)
webhook 通知を受け取る URL。形式:
uriGET /v2/models/bfl/flux-kontext-pro/openapi.json で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。出力
number
プロバイダーが報告するクレジット単位のコスト。タスクが Ready になると設定されます。形式:
floatstring
必須
BFL のタスク識別子。
number
BFL が報告するオプションの生成進捗。範囲:
0 から 1形式: floatobject
必須
完了した生成結果。ここでは nullable ではありません。このコンポーネントの
required エントリは 200 が結果を伴うことを約束するものであり、nullable な result はそれをキーの存在チェックにまで後退させてしまいます。number
プロバイダーが報告する生成のコスト。これは BFL の数値であり、Comfy の請求額ではありません。形式:
doublenumber
プロバイダーが報告する生成の所要時間(秒)。形式:
doublenumber
プロバイダーが報告する生成の完了時刻(Unix エポックからの秒数)。
start_time と同じ理由で double です。形式: doublestring
プロンプトのアップサンプリング後の、実際に生成が使用したプロンプト。
string (uri)
生成済みアセットの署名付き URL。Router はアセットを Comfy ストレージに再ホストしてこのフィールドを書き換えるため、通常は最大 24 時間有効な Comfy ホストの URL になります。発行時に 24 時間分の署名が付けられ、23 時間のメモから再生されるため、後でポーリングすると残り 1 時間しかない URL が返されることもあります。再ホストを実行できなかったリーフは、代わりに BFL 自身の短命な配信用 URL を保持します(ビデオでは約 2 時間、画像では約 10 分)。いずれにしてもリンクは期限切れになるため、URL を保存するのではなくアセットをダウンロードしてください。形式:
uriinteger
生成が使用したシード。指定されたものでもプロバイダーが選択したものでも同じです。
int64 として宣言されています。BFL は 2^31 を超えるシード(例: 2784347701)を返すことがあり、フォーマットされていない integer は多くの SDK ジェネレーターで 32 ビットフィールドとして生成されるためです。形式: int64number
プロバイダーが報告する生成の開始時刻(Unix エポックからの秒数)。
float ではなく double です。現在のエポック値付近では float32 の間隔が約 128 秒となり、生成全体の幅が単一のデコード値に潰れてしまうためです。形式: doublestring
必須
タスクのステータス: Pending、Reasoning、Generating、Ready、Request Moderated、Content Moderated、Error、または Task not found。
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。