bfl/flux-pro-1.0-depth の API リファレンス。Black Forest Labs から Comfy Router を介して提供されます。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用しています。cURL スニペットは、同じ呼び出しを生の HTTP で実行するものです。
モデル ID: bfl/flux-pro-1.0-depth
エンドポイント: POST https://api.comfy.org/v2/models/bfl/flux-pro-1.0-depth
- Wait for the result
- Queue and collect later
Schema
入力
string
control 入力として使用する Base64 エンコードされた画像
number
デフォルト:"15"
画像生成プロセスのガイダンス強度範囲:
1 から 100`jpeg`, `png`, `webp`
デフォルト:"\"jpeg\""
生成画像の出力フォーマット。‘jpeg’ または ‘png’ を指定できます。
string
control の前処理ステップをバイパスする、オプションの前処理済み画像
string
必須
画像生成のためのテキストプロンプト
boolean
デフォルト:"false"
プロンプトに対してアップサンプリングを実行するかどうか
integer
デフォルト:"2"
入力および出力のモデレーションに対する許容値。0 から 6 の間で、0 が最も厳しく、6 が最も緩くなります。範囲:
0 から 6integer
再現性のためのオプションのシード
integer
デフォルト:"50"
画像生成プロセスのステップ数範囲:
15 から 50string
webhook 署名検証用のオプションのシークレット
string (uri)
webhook 通知を受け取る URL
GET /v2/models/bfl/flux-pro-1.0-depth/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。
出力
number
プロバイダーが報告するクレジット単位のコスト。タスクが Ready になると設定されます。フォーマット:
floatstring
必須
BFL のタスク識別子。
number
BFL が報告するオプションの生成進捗。範囲:
0 から 1フォーマット: floatobject
必須
完了した生成結果。ここでは null 許容ではありません。このコンポーネントの
required エントリは、200 が結果を伴うことを約束するものであり、result が null 許容であると、それがキーの存在チェックにまで後退してしまうからです。number
プロバイダーが報告する生成のコスト。これは BFL の数値であり、Comfy の課金ではありません。フォーマット:
doublenumber
プロバイダーが報告する生成の所要時間(秒)。フォーマット:
doublenumber
プロバイダーが報告する生成の完了時刻(Unix エポックからの秒数)。
start_time と同じ理由で double です。フォーマット: doublestring
プロンプトのアップサンプリング後の、生成が実際に実行したプロンプト。
string (uri)
生成されたアセットの署名付き URL。Router はアセットを Comfy ストレージに再ホストし、このフィールドを書き換えるため、通常は最大 24 時間有効な Comfy ホストの URL となります。発行時に 24 時間の署名が付与され、23 時間のメモから再生成されるため、その後のポーリングでは残り 1 時間しかないものが返されることもあります。再ホストを実行できなかったリーフは、代わりに BFL 自身の短命な配信 URL を保持します(ビデオはおよそ 2 時間、画像はおよそ 10 分)。いずれの場合もリンクは失効するため、URL を保存するのではなくアセットをダウンロードしてください。フォーマット:
uriinteger
生成が使用したシード。指定されたものでもプロバイダーが選択したものでも同じです。BFL は 2^31 を超えるシード(例: 2784347701)を返すため、
int64 として宣言されています。フォーマットされていない 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 が現在対応していないことと、代替手段。