> ## 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 调用 Imagen 3.0 Generate 002

> 通过 Comfy Router 调用 vertexai/imagen-3.0-generate-002：端点、请求形状以及 Router 返回的响应。

`vertexai/imagen-3.0-generate-002` 的 API 参考文档，由 Comfy Router 从 Google 提供服务。

## 快速开始

在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys)中创建密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`）；cURL 代码片段则是通过原始 HTTP 发起的同一调用。

**模型 ID：** `vertexai/imagen-3.0-generate-002`

**端点：** `POST https://api.comfy.org/v2/models/vertexai/imagen-3.0-generate-002`

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # The SDK automatically creates an idempotency key and reuses it for automatic retries.
      with Comfy() as client:
          result = client.models.run(
              "vertexai/imagen-3.0-generate-002",
              {
                  "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";

      // Reads COMFY_API_KEY from the environment.
      // The SDK automatically creates an idempotency key and reuses it for automatic retries.
      const { data } = await comfy.models.run("vertexai/imagen-3.0-generate-002", {
        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-generate-002 \
        -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="Queue and collect later">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "vertexai/imagen-3.0-generate-002",
              {
                  "instances": [
                      {
                          "prompt": "A single red maple leaf on a plain white background.",
                      },
                  ],
                  "parameters": {
                      "sampleCount": 1,
                  },
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("vertexai/imagen-3.0-generate-002", {
        instances: [
          {
            prompt: "A single red maple leaf on a plain white background.",
          },
        ],
        parameters: {
          sampleCount: 1,
        },
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/vertexai/imagen-3.0-generate-002/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. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/vertexai/imagen-3.0-generate-002/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/vertexai/imagen-3.0-generate-002/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 输入

<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">
  范围：`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-generate-002/openapi.json` 提供的 schema 生成，该文档与请求到达提供商之前 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` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载，因为[结果链接会过期](/zh/development/comfy-router/reference#结果资产)。

<CardGroup cols={3}>
  <Card title="请求头" icon="list" href="/zh/development/comfy-router/quickstart">
    身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
  </Card>

  <Card title="使用 Router API" icon="code" href="/zh/development/comfy-router/quickstart">
    模型发现、校验错误、重试与计费。
  </Card>

  <Card title="限制" icon="triangle-exclamation" href="/zh/development/comfy-router/limitations">
    Router 目前不支持的功能，以及替代方案。
  </Card>
</CardGroup>