> ## 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.

# 将 Higgsfield Kling 3 Pro 与 Comfy Router 配合使用

> 通过 Comfy Router 调用 higgsfield/higgsfield-kling-3-pro：端点、请求结构以及 Router 返回的响应。

`higgsfield/higgsfield-kling-3-pro` 的 API 参考，由 Comfy Router 提供，来自 Higgsfield。

## 快速开始

在[你的 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：** `higgsfield/higgsfield-kling-3-pro`

**端点：** `POST https://api.comfy.org/v2/models/higgsfield/higgsfield-kling-3-pro`

<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(
              "higgsfield/higgsfield-kling-3-pro",
              {
                  "aspect_ratio": "16:9",
                  "cfg_scale": 0.5,
                  "duration": 5,
                  "prompt": "A cinematic glass pavilion in a misty pine forest at sunrise",
                  "sound": "on",
              },
          )

      print(result)
      ```

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

      // 从环境变量中读取 COMFY_API_KEY。
      // SDK 会自动创建幂等键，并在自动重试时复用它。
      const { data } = await comfy.models.run("higgsfield/higgsfield-kling-3-pro", {
        aspect_ratio: "16:9",
        cfg_scale: 0.5,
        duration: 5,
        prompt: "A cinematic glass pavilion in a misty pine forest at sunrise",
        sound: "on",
      });

      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(
          "higgsfield/higgsfield-kling-3-pro",
          input: [
              "aspect_ratio": "16:9",
              "cfg_scale": 0.5,
              "duration": 5,
              "prompt": "A cinematic glass pavilion in a misty pine forest at sunrise",
              "sound": "on",
          ]
      )

      print(result.output)
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/higgsfield/higgsfield-kling-3-pro \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"16:9\", \"cfg_scale\": 0.5, \"duration\": 5, \"prompt\": \"A cinematic glass pavilion in a misty pine forest at sunrise\", \"sound\": \"on\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="加入队列并稍后收集">
    相同的请求体，发送到 `POST https://api.comfy.org/v2/models/higgsfield/higgsfield-kling-3-pro/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(
              "higgsfield/higgsfield-kling-3-pro",
              {
                  "aspect_ratio": "16:9",
                  "cfg_scale": 0.5,
                  "duration": 5,
                  "prompt": "A cinematic glass pavilion in a misty pine forest at sunrise",
                  "sound": "on",
              },
          )
          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("higgsfield/higgsfield-kling-3-pro", {
        aspect_ratio: "16:9",
        cfg_scale: 0.5,
        duration: 5,
        prompt: "A cinematic glass pavilion in a misty pine forest at sunrise",
        sound: "on",
      });
      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(
          "higgsfield/higgsfield-kling-3-pro",
          input: [
              "aspect_ratio": "16:9",
              "cfg_scale": 0.5,
              "duration": 5,
              "prompt": "A cinematic glass pavilion in a misty pine forest at sunrise",
              "sound": "on",
          ]
      )
      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/higgsfield/higgsfield-kling-3-pro/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"16:9\", \"cfg_scale\": 0.5, \"duration\": 5, \"prompt\": \"A cinematic glass pavilion in a misty pine forest at sunrise\", \"sound\": \"on\"}"

      # 2. 轮询直到状态为 COMPLETED，每次响应都会指明 Retry-After 秒数，按其等待。
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/higgsfield/higgsfield-kling-3-pro/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 收集。200 表示模型的原生输出，202 表示仍在运行时的状态正文。
      curl https://api.comfy.org/v2/models/higgsfield/higgsfield-kling-3-pro/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;">
  输出比例。

  可选值：`16:9`, `9:16`, `1:1`
</ParamField>

<ParamField body="cfg_scale" type="number" default="0.5">
  生成结果对提示词的遵循程度。Higgsfield 文档说明为 0-1，步长 0.01，但此处只声明 0-1 的边界：`multipleOf: 0.01` 会在二进制浮点中求值，从而会拒绝 0.3 这样的普通取值，因此更精细的值会被接受并转发，而不是被拒绝，这与 `prompt` 对其未声明的长度上限所作的说明相同。

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

<ParamField body="duration" type="integer" default="5">
  输出时长，单位为秒。支持范围：3-15。

  范围：`3` 到 `15`
</ParamField>

<ParamField body="elements" type="string[]">
  可复用的 Kling 元素 id，用于在多次生成之间保持主体一致性。
</ParamField>

<ParamField body="multi_prompt" type="object[]">
  有序的分镜定义，在 `multi_shots` 为 true 时使用。1-6 个分镜；每个分镜的时长受任务自身总时长的约束，而这一点无法在此表达。
</ParamField>

<ParamField body="multi_prompt[].duration" type="integer">
  此分镜的时长，单位为秒，1-15。所有分镜的时长之和不得超过任务的总时长，JSON Schema 无法表达这一点；由 Higgsfield 强制执行。

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

<ParamField body="multi_prompt[].prompt" type="string">
  此分镜的提示词。Higgsfield 文档说明上限为 512 个字符。
</ParamField>

<ParamField body="multi_shots" type="boolean" default="false">
  启用多分镜序列。当为 true 时，由 `multi_prompt` 承载各分镜的定义。
</ParamField>

<ParamField body="prompt" type="string">
  描述期望输出的提示词。Higgsfield 文档说明 Kling 最多使用前 2,500 个字符，超出部分会被截断，因此这里不声明 maxLength：更长的正文会被接受，而不是被拒绝。
</ParamField>

<ParamField body="sound" type="string" default="&#x22;on&#x22;">
  启用或禁用生成的声音。

  可选值：`on`, `off`
</ParamField>

内容生成自 Router 在 `GET /v2/models/higgsfield/higgsfield-kling-3-pro/openapi.json` 提供的 schema，与请求到达提供商之前用于校验调用的文档相同。

### 输出

<ResponseField name="cancel_url" type="string">
  用于在处理开始之前取消请求的绝对 URL。
</ResponseField>

<ResponseField name="error" type="string">
  失败详情，当 `status` 为 `failed` 时设置。
</ResponseField>

<ResponseField name="request_id" type="string" required>
  用于轮询、取消和支持的稳定标识符。
</ResponseField>

<ResponseField name="status" type="string" required>
  当前请求状态。

  可选值：`queued`, `in_progress`, `nsfw`, `failed`, `completed`, `canceled`
</ResponseField>

<ResponseField name="status_url" type="string">
  用于轮询直到请求进入终端状态的绝对 URL。
</ResponseField>

<ResponseField name="video" type="object">
  一个 Higgsfield 媒体输出。
</ResponseField>

<ResponseField name="video.url" type="string" required>
  生成媒体的下载 URL。
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "aspect_ratio": "16:9",
  "cfg_scale": 0.5,
  "duration": 5,
  "prompt": "A cinematic glass pavilion in a misty pine forest at sunrise",
  "sound": "on"
}
```

### 输出

```json theme={null}
{
  "cancel_url": "https://api.higgsfield.ai/requests/d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff/cancel",
  "request_id": "d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff",
  "status": "completed",
  "status_url": "https://api.higgsfield.ai/requests/d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff/status",
  "video": {
    "url": "https://example.invalid/higgsfield/higgsfield-kling-3-pro/generated.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>