> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Comfy RouterでImageを使用する

> Comfy Router経由でbria/imageを呼び出します: エンドポイント、リクエストの形状、Routerが返すレスポンスについて説明します。

`bria/image` の API リファレンスです。Comfy Router が Bria から提供しています。

**入力:** テキスト、画像 · **出力:** 画像

## クイックスタート

[ご利用の Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（`pip install comfy-sdk` と `npm install @comfyorg/sdk`）を使用します。cURL のスニペットは、同じ呼び出しを生の HTTP で実行するものです。

**モデル ID:** `bria/image`

**エンドポイント:** `POST https://api.comfy.org/v2/models/bria/image`

**結果を待つ**

```python Python theme={null}
from comfy_sdk import Comfy

# 環境から COMFY_API_KEY を読み取ります。
# SDK は自動的に冪等キーを作成し、自動再試行のために再利用します。
with Comfy() as client:
    result = client.models.run(
        "bria/image",
        {
            "prompt": "A red vintage bicycle leaning against a brick wall in soft morning light",
        },
    )

print(result)
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// 環境から COMFY_API_KEY を読み取ります。
// SDK は自動的に冪等キーを作成し、自動再試行のために再利用します。
const { data } = await comfy.models.run("bria/image", {
  prompt: "A red vintage bicycle leaning against a brick wall in soft morning light",
});

console.log(data);
```

```bash cURL theme={null}
curl https://api.comfy.org/v2/models/bria/image \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"prompt\": \"A red vintage bicycle leaning against a brick wall in soft morning light\"}"
```

**キューに送信して後で収集**

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

```python Python theme={null}
import asyncio
from comfy_sdk import AsyncComfy

# 環境から COMFY_API_KEY を読み取ります。
# 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動再試行のために再利用します。
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "bria/image",
            {
                "prompt": "A red vintage bicycle leaning against a brick wall in soft morning light",
            },
        )
        print("request_id:", handle.request_id)  # モデル ID と合わせれば、別のプロセスに必要なのはこれだけです

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

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

    print(result)

asyncio.run(main())
```

```typescript TypeScript theme={null}
import { comfy } from "@comfyorg/sdk";

// 環境から COMFY_API_KEY を読み取ります。
// 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動再試行のために再利用します。
const handle = await comfy.models.submit("bria/image", {
  prompt: "A red vintage bicycle leaning against a brick wall in soft morning light",
});
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);
```

```bash cURL theme={null}
# 1. 送信。Router は request_id、status_url、response_url、cancel_url を伴う 201 を返します。
curl https://api.comfy.org/v2/models/bria/image/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"prompt\": \"A red vintage bicycle leaning against a brick wall in soft morning light\"}"

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

# 3. 収集。モデル本来の出力を伴う 200、まだ実行中の場合はステータスボディを伴う 202。
curl https://api.comfy.org/v2/models/bria/image/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"
```

## スキーマ

### 入力

**aspect\_ratio** `string` (default: "1:1")

出力画像のアスペクト比。"1:1"、"2:3"、"3:2"、"3:4"、"4:3"、"4:5"、"5:4"、"9:16"、"16:9"、"16:10"、"10:16"、"2:1"、"1:2"、"21:9"、"9:21"、"3:1"、"1:3"、"4:1"、"1:4"、"5:1"、"1:5" のいずれか。Bria は "16:10" 以降の比率を、"4MP" の場合、prompt と structured\_prompt の両方を送るリファインメントの場合、および prompt を持たない画像の場合に拒否します。

**images** `string[]`

新しい画像のヒントとなる参照画像。公開 URL または Base64 エンコード。対応フォーマットは JPEG、JPG、PNG、WEBP。要素は正確に 1 つだけ含める必要があります。

**ip\_signal** `boolean` (default: false)

true の場合、プロンプトに含まれる知的財産権コンテンツの可能性について警告を返します。

**model\_version** `string`

使用するモデルのバージョン。"FIBO" のみ指定できます。省略すると同じモデルが実行されます。

**output\_type** `string` (default: "png")

出力画像のフォーマット。"png" または "jpeg"。

**prompt** `string`

テキストによる指示。これ単体で新しい画像を生成するほか、images や structured\_prompt と組み合わせて結果を誘導したりリファインしたりできます。

**prompt\_content\_moderation** `boolean` (default: true)

true の場合、プロンプトのモデレーションに失敗すると 422 を返します。

**resolution** `string` (default: "1MP")

出力画像の解像度。"1MP" または "4MP"。"4MP" は画像のディテールを改善しますが、レイテンシが約 30 秒増加します。

**seed** `integer`

決定論的な生成のためのシード。省略した場合はランダムなシードが使用されます。

**structured\_prompt** `string`

以前の生成結果から得られた、JSON 形式の構造化プロンプトを含む文字列。同じシードとともに使用するとその画像を再現でき、一部を変更すると画像をリファインできます。

**visual\_input\_content\_moderation** `boolean` (default: true)

true の場合、入力画像のモデレーションに失敗すると 422 を返します。

**visual\_output\_content\_moderation** `boolean` (default: true)

true の場合、出力画像のモデレーションに失敗すると 422 を返します。

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

### 出力

**error** `object`

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

**error.code** `integer`

エラーコード。

**error.details** `string`

追加のエラー詳細。

**error.message** `string`

エラーメッセージ。

**request\_id** `string`

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

**result** `object`

結果オブジェクト (status が COMPLETED の場合のみ存在)

**result.image\_url** `string`

生成または編集された画像の URL。

**result.prompt** `string`

オリジナルのプロンプト。

**result.refined\_prompt** `string`

リファインされたプロンプト。Bria がリファインしなかった COMPLETED の生成では null。このキーは省略されるのではなく null を保持したまま PRESENT となるため nullable です。bria/image-edit-gen-fill で実際に確認済みです。

**result.seed** `integer`

生成に使用されたシード。

**result.structured\_instruction** `string`

`/v2/structured_instruction/generate` が返す、文字列としてシリアライズされた JSON ドキュメントである構造化命令。この操作はいずれの URL も埋めません。

**result.structured\_prompt** `string`

詳細な JSON 構造化プロンプト。

**result.video\_url** `string`

生成されたビデオの URL。

**status** `string`

リクエストの現在のステータス。

取りうる値: `IN_PROGRESS`、`COMPLETED`、`ERROR`、`UNKNOWN`

## 例

### 入力

```json theme={null}
{
  "prompt": "A red vintage bicycle leaning against a brick wall in soft morning light"
}
```

### 出力

```json theme={null}
{
  "request_id": "0b3f9d7e-2c41-4a8b-9f10-6d5c8e2a4b71",
  "result": {
    "image_url": "https://example.invalid/bria/image/generated.png",
    "seed": 42
  },
  "status": "COMPLETED"
}
```

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](/ja/development/comfy-router/reference#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](/ja/development/comfy-router/limitations) を参照してください。

このページは、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](/ja/development/api-development/sdks) を参照してください。

> **[ヘッダー](/ja/development/comfy-router/headers)**
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> **[Router API の利用](/ja/development/comfy-router/api)**
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> **[制限事項](/ja/development/comfy-router/limitations)**
>
> Router が現在対応していないことと、代替手段。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.