> ## 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 3 Image を使用する

> Comfy Router 経由で bfl/flux-3-image を呼び出します。エンドポイント、リクエスト形状、および Router が返すレスポンス。

Black Forest Labs の `bfl/flux-3-image` の API リファレンス。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 で行うものです。

**Model ID:** `bfl/flux-3-image`

**Endpoint:** `POST https://api.comfy.org/v2/models/bfl/flux-3-image`

<Tabs defaultTabIndex={1}>
  <Tab title="結果を待つ">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 環境変数から COMFY_API_KEY を読み取ります。
      # SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
      with Comfy() as client:
          result = client.models.run(
              "bfl/flux-3-image",
              {
                  "aspect_ratio": "16:9",
                  "prompt": "A mountain landscape at sunset",
                  "resolution": "1k",
              },
          )

      print(result)
      ```

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

      // 環境変数から COMFY_API_KEY を読み取ります。
      // SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
      const { data } = await comfy.models.run("bfl/flux-3-image", {
        aspect_ratio: "16:9",
        prompt: "A mountain landscape at sunset",
        resolution: "1k",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/bfl/flux-3-image \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"16:9\", \"prompt\": \"A mountain landscape at sunset\", \"resolution\": \"1k\"}"
      ```
    </CodeGroup>
  </Tab>

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

    <CodeGroup>
      ```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-3-image",
                  {
                      "aspect_ratio": "16:9",
                      "prompt": "A mountain landscape at sunset",
                      "resolution": "1k",
                  },
              )
              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-3-image", {
        aspect_ratio: "16:9",
        prompt: "A mountain landscape at sunset",
        resolution: "1k",
      });
      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-3-image/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"16:9\", \"prompt\": \"A mountain landscape at sunset\", \"resolution\": \"1k\"}"

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

      # 3. 収集。モデル本来の出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。
      curl https://api.comfy.org/v2/models/bfl/flux-3-image/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## スキーマ

### 入力

<ParamField body="aspect_ratio" type="string" default="&#x22;auto&#x22;">
  出力のアスペクト比: auto、21:9、2:1、16:9、3:2、7:5、4:3、5:4、1:1、4:5、3:4、5:7、2:3、9:16、1:2、または 9:21。auto は参照画像がある場合は最初の参照画像に従います。
</ParamField>

<ParamField body="grounding" type="boolean" default="true">
  モデルが生成前にウェブ検索と画像検索でプロンプトを調査できるようにします。両方をオフにするには false を設定します。
</ParamField>

<ParamField body="images" type="string | string[]">
  プロンプトが編集または参照する 1～10 枚の参照画像。それぞれ http(s) URL または base64 文字列です。単一の文字列は 1 件のリストとして扱われます。各画像は最小 256x256 ピクセル、最大 16 メガピクセルで、base64 ペイロードは最大 20 MB である必要があります。入力は最も近い解像度ビンにリサイズされ、最大 2k です。
</ParamField>

<ParamField body="prompt" type="string" required>
  生成する画像、または参照画像に適用する編集のテキストによる説明。
</ParamField>

<ParamField body="resolution" type="string" default="&#x22;1k&#x22;">
  出力解像度クラス: 768sq、1k、1.5k、2k、または 4k。
</ParamField>

<ParamField body="safety_tolerance" type="integer" default="2">
  入力と出力のモデレーションの許容値。0 が最も厳格です。

  範囲: `0` ～ `4`
</ParamField>

<ParamField body="version" type="string" default="&#x22;latest&#x22;">
  エンドポイントのバージョン。latest は現在のリリースを提供します。日付付きの固定可能なリリースタグは、公開され次第追加されます。
</ParamField>

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

### 出力

<ResponseField name="cost" type="number">
  プロバイダーが報告するクレジット単位のコスト。タスクが Ready になると値が入ります。

  形式: `float`
</ResponseField>

<ResponseField name="id" type="string" required>
  BFL のタスク識別子。
</ResponseField>

<ResponseField name="progress" type="number">
  BFL が報告するオプションの生成進捗。

  範囲: `0` ～ `1`

  形式: `float`
</ResponseField>

<ResponseField name="result" type="object" required>
  完了した生成。ここでは nullable ではありません。このコンポーネントの `required` エントリは、`200` が result を伴うことを約束するものであり、nullable な `result` ではキーの存在確認だけに矮小化されてしまいます。
</ResponseField>

<ResponseField name="result.cost" type="number">
  プロバイダーが報告する生成のコスト。これは BFL の数値であり、Comfy の課金ではありません。

  形式: `double`
</ResponseField>

<ResponseField name="result.duration" type="number">
  プロバイダーが報告する生成の再生時間（秒）。

  形式: `double`
</ResponseField>

<ResponseField name="result.end_time" type="number">
  プロバイダーが報告する生成の完了時刻。Unix エポックからの秒数です。`start_time` と同じ理由で `double` です。

  形式: `double`
</ResponseField>

<ResponseField name="result.prompt" type="string">
  プロンプトのアップサンプリング後の、生成が実際に実行したプロンプト。
</ResponseField>

<ResponseField name="result.sample" type="string (uri)">
  生成されたアセットの署名付き URL。Router はアセットを Comfy ストレージに再ホストしてこのフィールドを書き換えるため、通常は最大 24 時間有効な Comfy ホストの URL になります。発行時点で 24 時間の署名が付き、23 時間のメモから再生されるため、後のポーリングでは残り 1 時間しかないものが返ることもあります。再ホストを実行できなかったリーフは、代わりに BFL 自身の短命な配信 URL を保持します。ビデオではおよそ 2 時間、画像ではおよそ 10 分です。いずれにせよリンクは失効するため、URL を保存するのではなくアセットをダウンロードしてください。

  形式: `uri`
</ResponseField>

<ResponseField name="result.seed" type="integer">
  生成が使用したシード。指定されたものでもプロバイダーが選んだものでも同じです。`int64` として宣言されているのは、BFL が 2^31 を超えるシード（例: 2784347701）を返すためです。フォーマットされていない `integer` は、多くの SDK ジェネレーターで 32 ビットフィールドとして生成されます。

  形式: `int64`
</ResponseField>

<ResponseField name="result.start_time" type="number">
  プロバイダーが報告する生成の開始時刻。Unix エポックからの秒数です。`float` ではなく `double` です。現代のエポック値付近では float32 の間隔が約 128 秒となり、生成全体の範囲が単一のデコード値に潰れてしまうためです。

  形式: `double`
</ResponseField>

<ResponseField name="status" type="string" required>
  タスクステータス: Pending、Reasoning、Generating、Ready、Request Moderated、Content Moderated、Error、または Task not found。
</ResponseField>

## 例

### 入力

```json theme={null}
{
  "aspect_ratio": "16:9",
  "prompt": "A mountain landscape at sunset",
  "resolution": "1k"
}
```

### 出力

```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 の有効期限](/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) を参照してください。

<CardGroup cols={3}>
  <Card title="ヘッダー" icon="list" href="/ja/development/comfy-router/headers">
    認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
  </Card>

  <Card title="Router API の利用" icon="code" href="/ja/development/comfy-router/api">
    モデルの検出、バリデーションエラー、リトライ、課金。
  </Card>

  <Card title="制限事項" icon="triangle-exclamation" href="/ja/development/comfy-router/limitations">
    Router が現在対応していないことと、代替手段。
  </Card>
</CardGroup>


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