Comfy Router で Image Edit Replace Object By Text を使う

bria/image-edit-replace-object-by-text のAPIリファレンス。Comfy Router が Bria から提供しています。

クイックスタート

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

結果を待つ
キューに送信して後で収集

from comfy_sdk import Comfy

# 環境から COMFY_API_KEY を読み取ります。
# SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
with Comfy() as client:
    result = client.models.run(
        "bria/image-edit-replace-object-by-text",
        {
            "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
            "instruction": "Replace the pie with a chocolate cake",
        },
    )

print(result)

import { comfy } from "@comfyorg/sdk";

// 環境から COMFY_API_KEY を読み取ります。
// SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
const { data } = await comfy.models.run("bria/image-edit-replace-object-by-text", {
  image: "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
  instruction: "Replace the pie with a chocolate cake",
});

console.log(data);

import Foundation
import ComfySwiftSDK

// 環境から COMFY_API_KEY を読み取ります。
// SDK は呼び出しごとに冪等キーを発行し、自動リトライのために再利用します。
let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
let result = try await client.models.run(
    "bria/image-edit-replace-object-by-text",
    input: [
        "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
        "instruction": "Replace the pie with a chocolate cake",
    ]
)

print(result.output)

curl https://api.comfy.org/v2/models/bria/image-edit-replace-object-by-text \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg\", \"instruction\": \"Replace the pie with a chocolate cake\"}"

同じボディを POST https://api.comfy.org/v2/models/bria/image-edit-replace-object-by-text/requests に送信します。Router は実行が受け付けられるとすぐに request_id とともに 201 を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集されます。キュー配信では、ステータス、キャンセル、収集について順を追って説明します。

from comfy_sdk import Comfy

# 環境から COMFY_API_KEY を読み取ります。
# submit() の各呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
with Comfy() as client:
    handle = client.models.submit(
        "bria/image-edit-replace-object-by-text",
        {
            "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
            "instruction": "Replace the pie with a chocolate cake",
        },
    )
    print("request_id:", handle.request_id)  # モデル ID と合わせて、別のプロセスが必要とするすべての情報

    # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
    for update in handle.iter_events():
        print(update.status, update.queue_position)

    # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。
    # 失敗またはキャンセルされたリクエストは、ここで型付きの Router エラーを発生させます。
    result = handle.get()

print(result)

import { comfy } from "@comfyorg/sdk";

// 環境から COMFY_API_KEY を読み取ります。
// submit() の各呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
const handle = await comfy.models.submit("bria/image-edit-replace-object-by-text", {
  image: "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
  instruction: "Replace the pie with a chocolate cake",
});
console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスが必要とするすべての情報

// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// models.run() が返すのと同じ結果です。失敗またはキャンセルされたリクエストは、ここで reject されます。
const result = await handle.get();

console.log(result.data);

import Foundation
import ComfySwiftSDK

// 環境から COMFY_API_KEY を読み取ります。
// submit() の各呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
let handle = try await client.models.submit(
    "bria/image-edit-replace-object-by-text",
    input: [
        "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
        "instruction": "Replace the pie with a chocolate cake",
    ]
)
print("requestId:", handle.requestId)  // モデル ID と合わせて、別のプロセスが必要とするすべての情報

// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
for try await update in handle.events() {
    print(update.state.rawValue, update.queuePosition.map(String.init) ?? "unknown")
}

// プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。
// 失敗またはキャンセルされたリクエストは、ここで型付きの Router エラーをスローします。
let result = try await handle.result()

print(result.output)

# 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
curl https://api.comfy.org/v2/models/bria/image-edit-replace-object-by-text/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg\", \"instruction\": \"Replace the pie with a chocolate cake\"}"

# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/bria/image-edit-replace-object-by-text/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. 収集。実行中はステータスボディとともに 202、完了時はモデルのネイティブ出力とともに 200 を返します。
curl https://api.comfy.org/v2/models/bria/image-edit-replace-object-by-text/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"

スキーマ

入力

string

必須

編集する画像。サポートされる入力タイプは、Base64 エンコードされた文字列、または公開アクセス可能な画像ファイルを指す URL です。対応フォーマットは JPEG、JPG、PNG、WEBP です。

string

必須

置き換え内容を記述するテキスト指示（例:「赤いリンゴを緑のナシに置き換える」）。

Router が GET /v2/models/bria/image-edit-replace-object-by-text/openapi.json で提供するスキーマから生成されており、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるドキュメントと同じものです。

出力

object

エラーオブジェクト（status が ERROR の場合のみ存在）

integer

エラーコード。

string

追加のエラー詳細。

string

エラーメッセージ。

string

リクエストの一意の識別子。

object

結果オブジェクト（status が 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

例

入力

{
  "image": "https://img.freepik.com/free-psd/close-up-delicious-apple_23-2151868338.jpg",
  "instruction": "Replace the pie with a chocolate cake"
}

出力

{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "image_url": "https://example.invalid/bria/image-edit-replace-object-by-text/generated.png",
    "seed": 42
  },
  "status": "COMPLETED"
}

出荷前の確認

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 が現在対応していないことと、代替手段。

Comfy で開発する

ワークフローの実行

Comfy Router

Comfy CLI

仕様

Demo Apps

Comfy Router で Image Edit Replace Object By Text を使う

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認

ヘッダー

Router API の利用

制限事項

​クイックスタート

​スキーマ

​入力

​出力

​例

​入力

​出力

​出荷前の確認

ヘッダー

Router API の利用

制限事項

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認