Skip to main content
bria/image-edit-replace-background の API リファレンス。Bria から Comfy Router によって提供されています。

クイックスタート

あなたの Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python、TypeScript、Swift のスニペットは Comfy SDK(pip install comfy-sdknpm install @comfyorg/sdk、および ComfySwiftSDK Swift パッケージ)を使用しています。cURL のスニペットは同じ呼び出しを raw HTTP で行うものです。 モデル ID: bria/image-edit-replace-background エンドポイント: POST https://api.comfy.org/v2/models/bria/image-edit-replace-background

スキーマ

入力

boolean
true(デフォルト)の場合、参照画像に追加の処理を行うことで結果が改善されます。
boolean
true の場合、入力画像にアルファチャンネルがあっても、背景の検出と除去を強制します。
string
必須
編集する画像。対応する入力タイプは、Base64 エンコードされた文字列、または公開アクセス可能な画像ファイルを指す URL です。対応フォーマットは JPEG、JPG、PNG、WEBP です。
string
背景生成モードで、“base”、“high_control”(デフォルト)、“fast” のいずれかです。prompt が指定された場合にのみ適用されます。
string
生成される背景から除外する概念、スタイル、オブジェクトを指定するテキストプロンプト。
boolean
true の場合、出力はオリジナルの画像サイズを維持します。false(デフォルト)の場合、出力は 1MP にスケーリングされます。
string
新しい背景のテキスト記述。prompt または ref_images のいずれかを指定し、両方は指定しないでください。プロンプト内の 16 進数カラーコード(例: “#FF5733”)は単色の背景を生成します。
boolean
有効にすると、プロンプトにコンテンツモデレーションを適用します。プロンプトがモデレーションに失敗した場合は 422 を返します。
object
背景生成をガイドする 1 枚の参照画像、または参照画像のリスト。それぞれ Base64 エンコードされた文字列、または公開アクセス可能な画像ファイルを指す URL です。prompt または ref_images のいずれかを指定し、両方は指定しないでください。
boolean
true(デフォルト)の場合、最適な生成結果を得るためにプロンプトが自動的に調整されます。
integer
決定論的生成のためのシード。省略した場合は、ランダムなシードが使用されます。
boolean
false(デフォルト)の場合、リクエストは非同期で処理されます。true の場合、API は完了するまで接続を開いたまま保持します。COMFY ROUTER では、この 2 番目のモードは転送されず拒否されます。Router はディスパッチ前に返却モードを固定し、呼び出し内で結果をポーリングするため、POST /v2/models/bria/{model} は、このルートが false または null 以外の sync を伴う場合、invalid_input の 422 を返します(routerForbiddenBodyFields)。同期呼び出しは、このオペレーション自身の /proxy/ ルートでは引き続き利用可能であり、このスキーマが記述するのもそのサーフェスです。
boolean
有効にすると、結果のビジュアルにコンテンツモデレーションを適用します。出力がモデレーションに失敗した場合は 422 を返します。
Router が GET /v2/models/bria/image-edit-replace-background/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しの検証に使用するドキュメントと同じものです。

出力

object
エラーオブジェクト(status が ERROR の場合のみ存在)
integer
エラーコード。
string
追加のエラー詳細。
string
エラーメッセージ。
string
リクエストの一意の識別子。
object
結果オブジェクト(status が COMPLETED の場合のみ存在)
string
生成/編集された画像の URL。
string
オリジナルのプロンプト。
string
プロンプトの洗練されたバージョン。Bria が洗練しなかった COMPLETED の生成では null になります。キーが省略されるのではなく null を保持して PRESENT であるため nullable です。bria/image-edit-gen-fill で実際に確認されています。
integer
生成に使用されたシード。
string
詳細な JSON 構造化プロンプト。
string
生成されたビデオの URL。
string
リクエストの現在のステータス。指定可能な値: IN_PROGRESSCOMPLETEDERRORUNKNOWN

入力

出力

出荷前の確認

SDK は Idempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。 リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。 上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。 このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ comfy-sdk / @comfyorg/sdk パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: Comfy(api_key=...) / new Comfy({ apiKey })、および client.workflowsclient.assetsclient.jobsComfy SDKs を参照してください。

ヘッダー

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

Router API の利用

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

制限事項

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