Comfy Router で Video Edit Green Screen を使用する

Comfy Router が Bria から提供する bria/video-edit-green-screen の API リファレンス。

クイックスタート

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

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

from comfy_sdk import Comfy

# 環境変数から COMFY_API_KEY を読み取ります。
# SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
with Comfy() as client:
    result = client.models.run(
        "bria/video-edit-green-screen",
        {
            "green_shade": "broadcast_green",
            "video": "https://example.com/input.mp4",
        },
    )

print(result)

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

// 環境変数から COMFY_API_KEY を読み取ります。
// SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
const { data } = await comfy.models.run("bria/video-edit-green-screen", {
  green_shade: "broadcast_green",
  video: "https://example.com/input.mp4",
});

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/video-edit-green-screen",
    input: [
        "green_shade": "broadcast_green",
        "video": "https://example.com/input.mp4",
    ]
)

print(result.output)

curl https://api.comfy.org/v2/models/bria/video-edit-green-screen \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"green_shade\": \"broadcast_green\", \"video\": \"https://example.com/input.mp4\"}"

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

from comfy_sdk import Comfy

# 環境から COMFY_API_KEY を読み取ります。
# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。
with Comfy() as client:
    handle = client.models.submit(
        "bria/video-edit-green-screen",
        {
            "green_shade": "broadcast_green",
            "video": "https://example.com/input.mp4",
        },
    )
    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/video-edit-green-screen", {
  green_shade: "broadcast_green",
  video: "https://example.com/input.mp4",
});
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/video-edit-green-screen",
    input: [
        "green_shade": "broadcast_green",
        "video": "https://example.com/input.mp4",
    ]
)
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 は 201 とともに request_id、status_url、response_url、cancel_url を返します。
curl https://api.comfy.org/v2/models/bria/video-edit-green-screen/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"green_shade\": \"broadcast_green\", \"video\": \"https://example.com/input.mp4\"}"

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

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

スキーマ

入力

string

クロマキー用に前景の背後へ適用される単色の背景シェード。デフォルトは broadcast_green です。指定可能な値: broadcast_green、chroma_green、blue_screen

string

出力コンテナとコーデックのプリセット。指定可能な値: mp4_h264、mp4_h265、webm_vp9、mov_h265、mov_proresks、mkv_h264、mkv_h265、mkv_vp9、gif

boolean

入力ビデオのオーディオを保持するかどうか。

string

必須

入力ビデオの公開アクセス可能な URL。入力解像度は最大 16000x16000 (16K) までサポートされます。最大再生時間は 60 秒です。

Router が GET /v2/models/bria/video-edit-green-screen/openapi.json で提供するスキーマから生成されたもので、リクエストがプロバイダーに届く前に Router が呼び出しを検証する際に使用するドキュメントと同じです。

出力

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

例

入力

{
  "green_shade": "broadcast_green",
  "video": "https://example.com/input.mp4"
}

出力

{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "video_url": "https://example.invalid/bria/video-edit-green-screen/generated.mp4"
  },
  "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 で Video Edit Green Screen を使用する

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認

ヘッダー

Router API の利用

制限事項

​クイックスタート

​スキーマ

​入力

​出力

​例

​入力

​出力

​出荷前の確認

ヘッダー

Router API の利用

制限事項

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認