Skip to main content
Comfy Router が Black Forest Labs から提供する bfl/erase-v1 の API リファレンスです。

Quick start

Create a key in your Comfy workspace and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: bfl/erase-v1 Endpoint: POST https://api.comfy.org/v2/models/bfl/erase-v1

スキーマ

入力

integer
デフォルト:"10"
削除の前にマスクを膨張させるピクセル数。膨張はオブジェクトの輪郭を覆いやすくするのに役立ちます。最大25ピクセルです。範囲: 0 から 25
string
必須
Base64エンコードされた入力画像、またはHTTP(S)の画像URL。
string
必須
Base64エンコードされた白黒マスク、またはHTTP(S)の画像URL。白いピクセルは削除するオブジェクトを示し、黒いピクセルは保持されます。入力画像と同じ寸法である必要があります。
string
指定可能な値: jpegpngwebp
integer
デフォルト:"2"
入力と出力のモデレーションに対する許容値。0から5の間で、0が最も厳しく、5が最も緩くなります。範囲: 0 から 5
integer
再現性のための任意のシード。
string
webhook署名の検証用の任意のシークレット。
string (uri)
webhook通知を受け取るURL。形式: uri
Routerが GET /v2/models/bfl/erase-v1/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するのと同じドキュメントです。

出力

number
プロバイダーが報告するクレジット単位のコスト。タスクがReadyになった時点で設定されます。形式: float
string
必須
BFLのタスク識別子。
number
BFLが報告する任意の生成進捗。範囲: 0 から 1形式: float
object
必須
完了した生成結果。ここではnullableではありません。このコンポーネントの required エントリは、200 が結果を伴うことを約束するものであり、result をnullableにすると、単なるキーの存在確認にまで弱まってしまいます。
number
プロバイダーが報告する生成のコスト。これはBFLの数値であり、Comfyの課金額ではありません。形式: double
number
プロバイダーが報告する生成所要時間(秒)。形式: double
number
プロバイダーが報告する生成の完了時刻。Unixエポックからの秒数。double である理由は start_time と同じです。形式: double
string
実際に生成で実行されたプロンプト(プロンプトのアップサンプリング適用後)。
string (uri)
生成されたアセットへの署名付きURL。RouterはアセットをComfyのストレージに再ホストしてこのフィールドを書き換えるため、通常は最大24時間有効なComfyホストのURLになります。発行時に24時間分の署名が付与され、23時間のメモから再送されるため、後からのポーリングでは残り1時間程度のものが返ることがあります。再ホストを実行できなかったリーフは、代わりにBFL自身の短命な配信URLを保持します。ビデオでは約2時間、画像では約10分です。いずれの場合もリンクは失効するため、URLを保存するのではなくアセットをダウンロードしてください。形式: uri
integer
生成で使用されたシード。指定したものでもプロバイダーが選択したものでもかまいません。int64 として宣言されているのは、BFLが2^31を超えるシード(例: 2784347701)を返すためです。フォーマット指定のない integer では、多くのSDKジェネレーターで32ビットフィールドとして生成されてしまいます。形式: int64
number
プロバイダーが報告する生成の開始時刻。Unixエポックからの秒数。float ではなく double です。現在のエポック値付近ではfloat32の間隔が約128秒になるため、生成全体のスパンが単一のデコード値に潰れてしまいます。形式: double
string
必須
タスクのステータス: 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 が現在対応していないことと、代替手段。