> ## 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 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?onboarding=router)中创建密钥，并将其导出为 `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 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-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";

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会自动创建一个幂等键，并在自动重试时复用它。
      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="排队并稍后收集">
    相同的请求体发送到 `POST https://api.comfy.org/v2/models/vertexai/imagen-3.0-generate-002/requests`。运行被受理后，Router 会立即返回 `201` 和 `request_id`；结果就绪后，可以从本进程或其他进程收集。关于状态查询、取消与结果收集的完整说明，参见[队列投递](/zh/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-generate-002",
                  {
                      "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-generate-002", {
        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() 返回的结果相同。失败或已取消的请求会在这里被拒绝。
      const result = await handle.get();

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

      ```bash cURL theme={null}
      # 1. 提交。Router 返回 201，以及 request_id、status_url、response_url 和 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. 轮询直到状态为 COMPLETED，每次等待响应中指定的 Retry-After 秒数。
      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. 收集结果。返回 200 表示模型的原始输出；仍在运行时返回 202 及状态响应体。
      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" 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-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 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](/zh/development/comfy-router/reference#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](/zh/development/comfy-router/limitations)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](/zh/development/api-development/sdks)。

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

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

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