> ## 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 で FLUX 2 Pro を使用する

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

`bfl/flux-2-pro` の API リファレンスです。Black Forest Labs から Comfy Router によって提供されています。

**入力：** テキスト, 画像 · **出力：** 画像

## クイックスタート

[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:** `bfl/flux-2-pro`

**エンドポイント:** `POST https://api.comfy.org/v2/models/bfl/flux-2-pro`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "bfl/flux-2-pro",
>         {
>             "prompt": "A single red maple leaf on a plain white background.",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
> const { data } = await comfy.models.run("bfl/flux-2-pro", {
>   prompt: "A single red maple leaf on a plain white background.",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/bfl/flux-2-pro \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"prompt\": \"A single red maple leaf on a plain white background.\"}"
> ```

> [tab] キューに送信して後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/bfl/flux-2-pro/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は [キュー配信](https://docs.comfy.org/ja/development/comfy-router/queue.md) を参照してください。
>
> ```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(
>             "bfl/flux-2-pro",
>             {
>                 "prompt": "A single red maple leaf on a plain white background.",
>             },
>         )
>         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("bfl/flux-2-pro", {
>   prompt: "A single red maple leaf on a plain white background.",
> });
> 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/bfl/flux-2-pro/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"prompt\": \"A single red maple leaf on a plain white background.\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After の秒数だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/bfl/flux-2-pro/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集。モデルのネイティブ出力とともに 200、まだ実行中であればステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/bfl/flux-2-pro/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**height** `integer` (default: 1024)

画像の高さ。

範囲: `256` から `2048`

**input\_image** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_2** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_3** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_4** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_5** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_6** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_7** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_8** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**input\_image\_9** `string`

画像から画像への生成用の Base64 エンコードされた画像。

**output\_format** `string` (default: "jpeg")

生成される画像の出力形式。

指定可能な値: `jpeg`、`png`

**prompt** `string` *required*

生成する画像のテキスト説明。

**prompt\_upsampling** `boolean` (default: true)

生成時にプロンプトを自動的に変更します。

**safety\_tolerance** `integer` (default: 2)

モデレーションの許容レベル（Flux 2 Max のみ）。

範囲: `0` から `5`

**seed** `integer`

再現性のためのシード。

**width** `integer` (default: 1024)

画像の幅。

範囲: `256` から `2048`

Router が `GET /v2/models/bfl/flux-2-pro/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となるドキュメントと同じものです。

### 出力

**cost** `number`

プロバイダーが報告するクレジット単位のコスト。タスクが Ready になると設定されます。

形式: `float`

**id** `string` *required*

BFL のタスク識別子。

**progress** `number`

BFL が報告する任意の生成進捗。

範囲: `0` から `1`

形式: `float`

**result** `object` *required*

完了した生成結果。ここでは null 許容ではありません。このコンポーネントの `required` エントリは `200` が結果を伴うことを約束するものであり、`result` を null 許容にすると単なるキーの存在チェックに成り下がってしまいます。

**result.cost** `number`

プロバイダーが報告する生成コスト。これは BFL の数値であり、Comfy の請求額ではありません。

形式: `double`

**result.duration** `number`

プロバイダーが報告する生成の所要時間（秒）。

形式: `double`

**result.end\_time** `number`

プロバイダーが報告する生成の完了時刻。Unix エポックからの秒数です。`double` である理由は `start_time` と同じです。

形式: `double`

**result.prompt** `string`

実際に生成で使用されたプロンプト（プロンプトのアップサンプリング後）。

**result.sample** `string (uri)`

生成されたアセットへの署名付き URL。Router はアセットを Comfy のストレージに再ホストしてこのフィールドを書き換えるため、通常は Comfy がホストする最大 24 時間有効な URL になります。発行時に 24 時間分の署名が付与され、23 時間のメモから再生されるため、後でポーリングすると残り 1 時間程度の URL が返ることがあります。再ホストを実行できなかったリーフは、代わりに BFL 自身の短命な配信 URL を保持します（ビデオで約 2 時間、画像で約 10 分）。いずれの場合もリンクは期限切れになるため、URL を保存するのではなくアセットをダウンロードしてください。

形式: `uri`

**result.seed** `integer`

生成で使用されたシード（指定されたものか、プロバイダーが選択したものかを問いません）。`int64` として宣言されています。BFL は 2^31 を超えるシード（例: 2784347701）を返すことがあり、フォーマットされていない `integer` は多くの SDK ジェネレーターで 32 ビットのフィールドとして生成されるためです。

形式: `int64`

**result.start\_time** `number`

プロバイダーが報告する生成の開始時刻。Unix エポックからの秒数です。`float` ではなく `double` です。現在のエポック値付近では float32 の間隔が約 128 秒となり、生成全体の時間幅が単一のデコード値に潰れてしまうためです。

形式: `double`

**status** `string` *required*

タスクのステータス: Pending、Reasoning、Generating、Ready、Request Moderated、Content Moderated、Error、または Task not found。

## 例

### 入力

```json theme={null}
{
  "prompt": "A single red maple leaf on a plain white background."
}
```

### 出力

```json theme={null}
{
  "cost": null,
  "id": "b2e0c1a4-0f2f-4a55-9f2e-2f9a1c0d4e77",
  "progress": null,
  "result": {
    "cost": null,
    "duration": 3.4,
    "end_time": 1767225603.4,
    "prompt": "A watercolor painting of a lighthouse at dawn, soft light on the water",
    "sample": "https://example.invalid/bfl/flux-pro-1.1/sample.png",
    "seed": 2784347701,
    "start_time": 1767225600
  },
  "status": "Ready"
}
```

## 出荷前の確認

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

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

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

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

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

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

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


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