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

# Comfy Router で Imagen 3.0 Fast Generate 001 を使用する

> Comfy Router 経由で vertexai/imagen-3.0-fast-generate-001 を呼び出します。endpoint、リクエストの形状、Router が返すレスポンスについて説明します。

Google の Comfy Router が提供する `vertexai/imagen-3.0-fast-generate-001` の API リファレンスです。

## クイックスタート

[あなたの 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:** `vertexai/imagen-3.0-fast-generate-001`

**エンドポイント:** `POST https://api.comfy.org/v2/models/vertexai/imagen-3.0-fast-generate-001`

<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(
              "vertexai/imagen-3.0-fast-generate-001",
              {
                  "instances": [
                      {
                          "prompt": "A single red maple leaf on a plain white background.",
                      },
                  ],
                  "parameters": {
                      "sampleCount": 1,
                  },
              },
          )

      print(result)
      ```

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

      // 環境変数から COMFY_API_KEY を読み取ります。
      // SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
      const { data } = await comfy.models.run("vertexai/imagen-3.0-fast-generate-001", {
        instances: [
          {
            prompt: "A single red maple leaf on a plain white background.",
          },
        ],
        parameters: {
          sampleCount: 1,
        },
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/vertexai/imagen-3.0-fast-generate-001 \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"instances\": [{\"prompt\":\"A single red maple leaf on a plain white background.\"}], \"parameters\": {\"sampleCount\":1}}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="キューに送信して後で取得">
    同じボディを `POST https://api.comfy.org/v2/models/vertexai/imagen-3.0-fast-generate-001/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は [キュー配信](/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(
                  "vertexai/imagen-3.0-fast-generate-001",
                  {
                      "instances": [
                          {
                              "prompt": "A single red maple leaf on a plain white background.",
                          },
                      ],
                      "parameters": {
                          "sampleCount": 1,
                      },
                  },
              )
              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("vertexai/imagen-3.0-fast-generate-001", {
        instances: [
          {
            prompt: "A single red maple leaf on a plain white background.",
          },
        ],
        parameters: {
          sampleCount: 1,
        },
      });
      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/vertexai/imagen-3.0-fast-generate-001/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"instances\": [{\"prompt\":\"A single red maple leaf on a plain white background.\"}], \"parameters\": {\"sampleCount\":1}}"

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

      # 3. 取得。完了時はモデルのネイティブ出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
      curl https://api.comfy.org/v2/models/vertexai/imagen-3.0-fast-generate-001/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## スキーマ

### 入力

<ParamField body="instances" type="object[]" required />

<ParamField body="instances[].prompt" type="string" required>
  画像生成用のテキストプロンプト
</ParamField>

<ParamField body="parameters" type="object" />

<ParamField body="parameters.addWatermark" type="boolean" />

<ParamField body="parameters.aspectRatio" type="string">
  指定可能な値: `1:1`、`9:16`、`16:9`、`3:4`、`4:3`
</ParamField>

<ParamField body="parameters.enhancePrompt" type="boolean" />

<ParamField body="parameters.includeRaiReason" type="boolean" />

<ParamField body="parameters.includeSafetyAttributes" type="boolean" />

<ParamField body="parameters.outputOptions" type="object" />

<ParamField body="parameters.outputOptions.compressionQuality" type="integer">
  範囲: `0` から `100`
</ParamField>

<ParamField body="parameters.outputOptions.mimeType" type="string">
  指定可能な値: `image/png`、`image/jpeg`
</ParamField>

<ParamField body="parameters.personGeneration" type="string">
  指定可能な値: `dont_allow`、`allow_adult`、`allow_all`
</ParamField>

<ParamField body="parameters.safetySetting" type="string">
  指定可能な値: `block_most`、`block_some`、`block_few`、`block_fewest`
</ParamField>

<ParamField body="parameters.sampleCount" type="integer" default="4">
  範囲: `1` から `4`
</ParamField>

<ParamField body="parameters.seed" type="integer">
  フォーマット: `uint32`
</ParamField>

<ParamField body="parameters.storageUri" type="string" />

Router が `GET /v2/models/vertexai/imagen-3.0-fast-generate-001/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。

### 出力

<ResponseField name="predictions" type="object[]" />

<ResponseField name="predictions[].bytesBase64Encoded" type="string (byte)">
  Base64 エンコードされた画像コンテンツ

  フォーマット: `byte`
</ResponseField>

<ResponseField name="predictions[].mimeType" type="string">
  生成された画像の MIME タイプ
</ResponseField>

<ResponseField name="predictions[].prompt" type="string">
  この画像の生成に使用された、拡張または書き換えられたプロンプト
</ResponseField>

## 例

### 入力

```json theme={null}
{
  "instances": [
    {
      "prompt": "A single red maple leaf on a plain white background."
    }
  ],
  "parameters": {
    "sampleCount": 1
  }
}
```

### 出力

```json theme={null}
{
  "predictions": [
    {
      "bytesBase64Encoded": "PGJhc2U2ND4=",
      "mimeType": "image/png",
      "prompt": "A lighthouse at the edge of the harbour at dawn, warm low sun"
    }
  ]
}
```

## 出荷前の確認

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>