> ## 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 调用 Crystal Upscaler

> 通过 Comfy Router 调用 fal/crystal-upscaler：端点、请求形状以及 Router 返回的响应。

`fal/crystal-upscaler` 的 API 参考，由 Comfy Router 从 fal 提供。

**输入：** 图像 · **输出：** 图像

## 快速开始

在[你的 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：** `fal/crystal-upscaler`

**Endpoint：** `POST https://api.comfy.org/v2/models/fal/crystal-upscaler`

<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(
              "fal/crystal-upscaler",
              {
                  "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
                  "scale_factor": 2,
              },
          )

      print(result)
      ```

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

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会自动创建幂等键，并在自动重试时复用它。
      const { data } = await comfy.models.run("fal/crystal-upscaler", {
        image_url: "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
        scale_factor: 2,
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/fal/crystal-upscaler \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image_url\": \"https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png\", \"scale_factor\": 2}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="排队并稍后收集">
    相同的请求体，发送到 `POST https://api.comfy.org/v2/models/fal/crystal-upscaler/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(
                  "fal/crystal-upscaler",
                  {
                      "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
                      "scale_factor": 2,
                  },
              )
              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("fal/crystal-upscaler", {
        image_url: "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
        scale_factor: 2,
      });
      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/fal/crystal-upscaler/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image_url\": \"https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png\", \"scale_factor\": 2}"

      # 2. 轮询直到状态为 COMPLETED，并按每次响应指定的 Retry-After 秒数等待。
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/fal/crystal-upscaler/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 收集。返回 200 时带有模型的原生输出；任务仍在运行时返回 202 和状态响应体。
      curl https://api.comfy.org/v2/models/fal/crystal-upscaler/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### 输入

<ParamField body="creativity" type="number" default="0">
  模型可以自行创造多少新细节。0 表示最接近输入图像。

  范围：`0` 到 `10`
</ParamField>

<ParamField body="image_url" type="string" required>
  输入图像的 URL（JPEG、PNG、WebP、GIF 或 AVIF，最大 100 MB）。
</ParamField>

<ParamField body="output_format" type="string" default="&#x22;jpg&#x22;">
  输出图像格式：png 或 jpg。
</ParamField>

<ParamField body="scale_factor" type="number" default="2">
  应用于输入图像每一边的倍数。fal 按输出百万像素计费，因此价格随该值的平方增长。

  范围：`1` 到 `200`
</ParamField>

根据 Router 在 `GET /v2/models/fal/crystal-upscaler/openapi.json` 提供的 schema 生成，请求到达提供商之前，Router 也用同一份文档校验调用。

### 输出

<ResponseField name="images" type="object[]" required>
  放大后的图像。
</ResponseField>

<ResponseField name="images[].content_type" type="string">
  图像文件的 MIME 类型。
</ResponseField>

<ResponseField name="images[].file_name" type="string">
  图像文件的名称。
</ResponseField>

<ResponseField name="images[].file_size" type="integer">
  图像文件的大小，单位为字节。
</ResponseField>

<ResponseField name="images[].height" type="integer">
  图像的高度，单位为像素。fal 返回 null。
</ResponseField>

<ResponseField name="images[].url" type="string" required>
  放大后图像的 URL。
</ResponseField>

<ResponseField name="images[].width" type="integer">
  图像的宽度，单位为像素。fal 返回 null。
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "image_url": "https://storage.googleapis.com/falserverless/gallery/patina-blog-hero-render.png",
  "scale_factor": 2
}
```

### 输出

```json theme={null}
{
  "images": [
    {
      "content_type": "image/png",
      "file_name": "upscaled.png",
      "file_size": 1412332,
      "height": null,
      "url": "https://example.invalid/fal/crystal-upscaler/upscaled.png",
      "width": null
    }
  ]
}
```

## 发布前须知

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>


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