bria/image-edit-erase の API リファレンスです。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットでは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用します。cURL のスニペットは、raw HTTP 経由で同じ呼び出しを行います。
モデル ID: bria/image-edit-erase
エンドポイント: POST https://api.comfy.org/v2/models/bria/image-edit-erase
- 結果を待つ
- キューに入れて後で収集
同じボディを
POST https://api.comfy.org/v2/models/bria/image-edit-erase/requests に送信します。Router は実行が受け付けられるとすぐに request_id とともに 201 を返し、結果は準備ができたら、このプロセスからでも別のプロセスからでも収集できます。キューの配信では、ステータス、キャンセル、収集について説明します。スキーマ
入力
string
必須
編集する画像。サポートされる入力タイプは Base64 エンコードされた文字列、または公開アクセス可能な画像ファイルを指す URL です。対応フォーマットは JPEG、JPG、PNG、WEBP です。
string
必須
削除する領域を定義するマスク。Base64 エンコードされた文字列、または公開アクセス可能な画像ファイルを指す URL です。白いピクセル (255) は削除する領域を示し、黒いピクセル (0) は保持されます。
string
指定するマスクのタイプ。“manual”(デフォルト)または “automatic” のいずれかです。
boolean
入力画像の部分的に透明な領域を出力に保持するかどうかを制御します。
boolean
false(デフォルト)の場合、リクエストは非同期で処理されます。true の
場合、API は完了するまで接続を開いたまま保持します。Comfy
Router では、この第 2 のモードは転送されず拒否されます。Router
はディスパッチ前に返却モードを固定し、呼び出し内で結果をポーリングするため、
POST /v2/models/bria/{model} は、このルートが運ぶ sync が false
または null 以外の場合、422
invalid_input を返します(routerForbiddenBodyFields)。同期呼び出しは
このオペレーション自身の /proxy/ ルートでは引き続き利用可能であり、それが
このスキーマが記述するサーフェスでもあります。boolean
有効にすると、入力ビジュアルにコンテンツモデレーションを適用します。画像がモデレーションに失敗した場合は 422 を返します。
boolean
有効にすると、結果のビジュアルにコンテンツモデレーションを適用します。出力がモデレーションに失敗した場合は 422 を返します。
GET /v2/models/bria/image-edit-erase/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となる同一のドキュメントです。
出力
object
エラーオブジェクト(ステータスが ERROR の場合にのみ存在)
integer
エラーコード。
string
追加のエラー詳細。
string
エラーメッセージ。
string
リクエストの一意の識別子。
object
結果オブジェクト(ステータスが COMPLETED の場合にのみ存在)
string
生成または編集された画像の URL。
string
オリジナルのプロンプト。
string
プロンプトを洗練したバージョン。COMPLETED の生成で Bria が洗練しなかった場合は 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 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。
このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ comfy-sdk / @comfyorg/sdk パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: Comfy(api_key=...) / new Comfy({ apiKey })、および client.workflows、client.assets、client.jobs。Comfy SDKs を参照してください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。