bria/image-edit-remove-background の API リファレンスです。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用しています。cURL スニペットは同じ呼び出しを raw HTTP で行うものです。
モデル ID: bria/image-edit-remove-background
エンドポイント: POST https://api.comfy.org/v2/models/bria/image-edit-remove-background
- Wait for the result
- Queue and collect later
スキーマ
入力
string
必須
背景を除去する画像。対応する入力タイプは、Base64 エンコードされた文字列、または公開アクセス可能な画像ファイルを指す URL です。対応フォーマットは JPEG、JPG、PNG、WEBP です。
boolean
背景除去後に入力画像の部分的に透明な領域を出力で保持するかどうかを制御します。
boolean
false(デフォルト)の場合、リクエストは非同期で処理されます。true の場合、API は完了するまで接続を開いたまま保持します。
boolean
有効にすると、入力ビジュアルにコンテンツモデレーションを適用します。画像がモデレーションに失敗した場合は 422 を返します。
boolean
有効にすると、結果のビジュアルにコンテンツモデレーションを適用します。出力がモデレーションに失敗した場合は 422 を返します。
GET /v2/models/bria/image-edit-remove-background/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用するドキュメントと同じものです。
出力
object
エラーオブジェクト(status が ERROR の場合のみ存在)
integer
エラーコード。
string
エラーの追加詳細。
string
エラーメッセージ。
string
リクエストの一意の識別子。
object
結果オブジェクト(status が COMPLETED の場合のみ存在)
string
生成または編集された画像の URL。
string
オリジナルのプロンプト。
string
プロンプトの改良版。または、Bria が改良しなかった COMPLETED の生成では null。キーが省略されるのではなく null を保持して存在するため nullable です。bria/image-edit-gen-fill で実際に観測されています。
integer
生成に使用されたシード。
string
詳細な JSON 構造化プロンプト。
string
生成されたビデオの URL。
string
リクエストの現在のステータス。取り得る値:
IN_PROGRESS、COMPLETED、ERROR、UNKNOWN例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。