> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-mintlify-theme-mint.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 在 Comfy Router 中使用 H3 Max

> 通过 Comfy Router 调用 fal/h3-max：端点、请求结构以及 Router 返回的响应。

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

## 快速开始

在[您的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建密钥，并将其导出为 `COMFY_API_KEY`。Python、TypeScript 和 Swift 代码片段使用 Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`，以及 [`ComfySwiftSDK`](https://github.com/Comfy-Org/comfy-swift-sdk) Swift 包）；cURL 代码片段是通过原始 HTTP 进行的相同调用。

**模型 ID：** `fal/h3-max`

**端点：** `POST https://api.comfy.org/v2/models/fal/h3-max`

<Tabs>
  <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/h3-max",
              {
                  "duration": 5,
                  "prompt": "a red fox running through a snowy forest",
                  "prompt_expansion_mode": "balanced",
                  "resolution": "480P",
              },
          )

      print(result)
      ```

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

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会自动创建幂等键，并在自动重试时复用它。
      const { data } = await comfy.models.run("fal/h3-max", {
        duration: 5,
        prompt: "a red fox running through a snowy forest",
        prompt_expansion_mode: "balanced",
        resolution: "480P",
      });

      console.log(data);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 每次调用都会生成一个幂等键，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let result = try await client.models.run(
          "fal/h3-max",
          input: [
              "duration": 5,
              "prompt": "a red fox running through a snowy forest",
              "prompt_expansion_mode": "balanced",
              "resolution": "480P",
          ]
      )

      print(result.output)
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/fal/h3-max \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"duration\": 5, \"prompt\": \"a red fox running through a snowy forest\", \"prompt_expansion_mode\": \"balanced\", \"resolution\": \"480P\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="排队并稍后收集">
    将相同的请求体发送到 `POST https://api.comfy.org/v2/models/fal/h3-max/requests`。运行被受理后，Router 会立即返回 `201` 和 `request_id`；结果就绪后，可以从本进程或其他进程收集。状态、取消与收集的细节见 [队列投递](/zh/development/comfy-router/queue)。

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 从环境变量中读取 COMFY_API_KEY。
      # 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      with Comfy() as client:
          handle = client.models.submit(
              "fal/h3-max",
              {
                  "duration": 5,
                  "prompt": "a red fox running through a snowy forest",
                  "prompt_expansion_mode": "balanced",
                  "resolution": "480P",
              },
          )
          print("request_id:", handle.request_id)  # 再加上模型 ID，就是另一个进程所需的全部信息

          # 轮询直到请求完成，按服务器指定的 Retry-After 等待。
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # 提供商自己的载荷，与 models.run() 返回的值相同。
          # 失败或已取消的请求会在此处抛出带类型的 Router 错误。
          result = handle.get()

      print(result)
      ```

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

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      const handle = await comfy.models.submit("fal/h3-max", {
        duration: 5,
        prompt: "a red fox running through a snowy forest",
        prompt_expansion_mode: "balanced",
        resolution: "480P",
      });
      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);
      ```

      ```swift Swift theme={null}
      import Foundation
      import ComfySwiftSDK

      // 从环境变量中读取 COMFY_API_KEY。
      // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
      let client = ComfyCloudClient(apiKey: ProcessInfo.processInfo.environment["COMFY_API_KEY"]!)
      let handle = try await client.models.submit(
          "fal/h3-max",
          input: [
              "duration": 5,
              "prompt": "a red fox running through a snowy forest",
              "prompt_expansion_mode": "balanced",
              "resolution": "480P",
          ]
      )
      print("requestId:", handle.requestId)  // 再加上模型 ID，就是另一个进程所需的全部信息

      // 轮询直到请求完成，按服务器指定的 Retry-After 等待。
      for try await update in handle.events() {
          print(update.state.rawValue, update.queuePosition.map(String.init) ?? "unknown")
      }

      // 提供商自己的载荷，与 models.run() 返回的值相同。
      // 失败或已取消的请求会在此处抛出带类型的 Router 错误。
      let result = try await handle.result()

      print(result.output)
      ```

      ```bash cURL theme={null}
      # 1. 提交。Router 返回 201，并附带 request_id、status_url、response_url 和 cancel_url。
      curl https://api.comfy.org/v2/models/fal/h3-max/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"duration\": 5, \"prompt\": \"a red fox running through a snowy forest\", \"prompt_expansion_mode\": \"balanced\", \"resolution\": \"480P\"}"

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

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

## Schema

### 输入

<ParamField body="aspect_ratio" type="string" default="&#x22;16:9&#x22;">
  宽高比：21:9、16:9、4:3、1:1、3:4 或 9:16。
</ParamField>

<ParamField body="duration" type="integer" default="5">
  已生成视频的时长，单位为秒。
</ParamField>

<ParamField body="enable_safety_checker" type="boolean" default="true">
  启用安全检查器。
</ParamField>

<ParamField body="prompt" type="string" required>
  用于生成视频的文本提示词。
</ParamField>

<ParamField body="prompt_expansion_mode" type="string" required>
  在生成之前为重写提示词投入多少精力：balanced 或 quality。
</ParamField>

<ParamField body="resolution" type="string" default="&#x22;768P&#x22;">
  已生成视频的分辨率：480P 或 768P。
</ParamField>

<ParamField body="seed" type="integer">
  随机种子。省略时会选择一个随机种子。
</ParamField>

<ParamField body="sync_mode" type="boolean">
  以 base64 返回已生成的视频，而不是 CDN URL。
</ParamField>

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

### 输出

<ResponseField name="expanded_prompt" type="string">
  发送给模型时经过扩展之后的提示词。
</ResponseField>

<ResponseField name="timings" type="object">
  端到端耗时明细（秒）。
</ResponseField>

<ResponseField name="video" type="object" required>
  已生成的视频文件。
</ResponseField>

<ResponseField name="video.content_type" type="string">
  视频文件的 MIME 类型。
</ResponseField>

<ResponseField name="video.file_name" type="string">
  视频文件的名称。
</ResponseField>

<ResponseField name="video.file_size" type="integer">
  视频文件的大小，单位为字节。
</ResponseField>

<ResponseField name="video.url" type="string">
  已生成视频的 URL。
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "duration": 5,
  "prompt": "a red fox running through a snowy forest",
  "prompt_expansion_mode": "balanced",
  "resolution": "480P"
}
```

### 输出

```json theme={null}
{
  "expanded_prompt": "a single red maple leaf falling onto still water, cinematic, 4k",
  "timings": {
    "inference": 42.5
  },
  "video": {
    "content_type": "video/mp4",
    "file_name": "output.mp4",
    "file_size": 4194304,
    "url": "https://example.invalid/fal/minimax/h3-max/output.mp4"
  }
}
```

## 发布前须知

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>
