Skip to main content
Comfy Router が Black Forest Labs から提供する bfl/vto-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/vto-v1 Endpoint: POST https://api.comfy.org/v2/models/bfl/vto-v1

Schema

Input

string
必須
1 つ以上の衣料品の画像(内部的に input_image_2 にマッピングされます)。
string
指定可能な値: jpegpngwebp
string
必須
人物画像(内部的に input_image にマッピングされます)。
string
必須
VTO 生成のためのテキストプロンプト。
integer
デフォルト:"2"
入力および出力のモデレーションに対する許容値。公開利用では 0 から 5 の間。範囲: 0 から 5
integer
再現性のための任意のシード。
string
webhook 署名検証用の任意のシークレット。
string (uri)
webhook 通知を受け取る URL。形式: uri
Router が GET /v2/models/bfl/vto-v1/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しの検証に使用するのと同じドキュメントです。

Output

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

Examples

Input

Output

出荷前の確認

SDK は Idempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。 リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。

ヘッダー

認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

Router API の利用

モデルの検出、バリデーションエラー、リトライ、課金。

制限事項

Router が現在対応していないことと、代替手段。