Comfy Router で Image Edit Relight を使う

Bria が提供する bria/image-edit-relight の API リファレンスです。Comfy Router を通じて配信されています。

クイックスタート

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

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

from comfy_sdk import Comfy

# 環境変数から COMFY_API_KEY を読み取ります。
# SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。
with Comfy() as client:
    result = client.models.run(
        "bria/image-edit-relight",
        {
            "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80",
            "light_direction": "side",
            "light_type": "midday",
        },
    )

print(result)

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

// 環境変数から COMFY_API_KEY を読み取ります。
// SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。
const { data } = await comfy.models.run("bria/image-edit-relight", {
  image: "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80",
  light_direction: "side",
  light_type: "midday",
});

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-relight",
    input: [
        "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80",
        "light_direction": "side",
        "light_type": "midday",
    ]
)

print(result.output)

curl https://api.comfy.org/v2/models/bria/image-edit-relight \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80\", \"light_direction\": \"side\", \"light_type\": \"midday\"}"

同じボディを POST https://api.comfy.org/v2/models/bria/image-edit-relight/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-relight",
        {
            "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80",
            "light_direction": "side",
            "light_type": "midday",
        },
    )
    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-relight", {
  image: "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80",
  light_direction: "side",
  light_type: "midday",
});
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-relight",
    input: [
        "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80",
        "light_direction": "side",
        "light_type": "midday",
    ]
)
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-relight/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80\", \"light_direction\": \"side\", \"light_type\": \"midday\"}"

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

# 3. 収集。モデル本来の出力とともに 200、まだ実行中であればステータスボディとともに 202 を返します。
curl https://api.comfy.org/v2/models/bria/image-edit-relight/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"

スキーマ

入力

string

必須

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

string

ライトの方向。“front”、“side”、“bottom”、“top-down” のいずれか。

string

必須

適用するライティングの雰囲気。“midday”、“blue hour light”、“low-angle sunlight”、“sunrise light”、“spotlight on subject, keep background settings”、“overcast light”、“soft overcast daylight lighting”、“cloud-filtered lighting”、“fog-diffused lighting”、“moonlight lighting”、“starlight lighting nighttime”、“soft bokeh lighting”、“harsh studio lighting keep background setting” のいずれか。

Router が GET /v2/models/bria/image-edit-relight/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

例

入力

{
  "image": "https://img.freepik.com/free-photo/portrait-woman_395237-33.jpg?w=740&q=80",
  "light_direction": "side",
  "light_type": "midday"
}

出力

{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "image_url": "https://example.invalid/bria/image-edit-relight/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 Relight を使う

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認

ヘッダー

Router API の利用

制限事項

​クイックスタート

​スキーマ

​入力

​出力

​例

​入力

​出力

​出荷前の確認

ヘッダー

Router API の利用

制限事項

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認