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

# Use Higgsfield Kling 3 Pro with Comfy Router

> Call higgsfield/higgsfield-kling-3-pro through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `higgsfield/higgsfield-kling-3-pro`, served by Comfy Router from Higgsfield.

## Quick start

Create a key in [your Comfy workspace](https://platform.comfy.org/profile/api-keys) and export it as `COMFY_API_KEY`. The Python, TypeScript and Swift snippets use the Comfy SDKs (`pip install comfy-sdk`, `npm install @comfyorg/sdk`, and the [`ComfySwiftSDK`](https://github.com/Comfy-Org/comfy-swift-sdk) Swift package); the cURL snippet is the same call over raw HTTP.

**Model ID:** `higgsfield/higgsfield-kling-3-pro`

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

<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(
              "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";

      // 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("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

      // Reads COMFY_API_KEY from the environment.
      // The SDK mints an idempotency key per call and reuses it for automatic retries.
      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="Queue and collect later">
    The same body, sent to `POST https://api.comfy.org/v2/models/higgsfield/higgsfield-kling-3-pro/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](/development/comfy-router/queue) walks through status, cancellation and collection.

    <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(
              "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)  # 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("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); // 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);
      ```

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

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      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)  // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for try await update in handle.events() {
          print(update.state.rawValue, update.queuePosition.map(String.init) ?? "unknown")
      }

      // The provider's own payload, the same value models.run() returns.
      // A request that failed or was cancelled throws the typed Router error here.
      let result = try await handle.result()

      print(result.output)
      ```

      ```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/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. 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/higgsfield/higgsfield-kling-3-pro/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/higgsfield/higgsfield-kling-3-pro/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### Input

<ParamField body="aspect_ratio" type="string" default="&#x22;16:9&#x22;">
  Output aspect ratio.

  Possible values: `16:9`, `9:16`, `1:1`
</ParamField>

<ParamField body="cfg_scale" type="number" default="0.5">
  How strongly the generation follows the prompt. Higgsfield documents 0-1 in increments of 0.01, but only the 0-1 bound is declared here: a `multipleOf: 0.01` would be evaluated in binary floating point and would refuse ordinary values such as 0.3, so a finer-grained value is ACCEPTED and forwarded rather than refused, the same way `prompt` caveats its undeclared length ceiling.

  Range: `0` to `1`
</ParamField>

<ParamField body="duration" type="integer" default="5">
  Output duration in seconds. Supported range: 3-15.

  Range: `3` to `15`
</ParamField>

<ParamField body="elements" type="string[]">
  Reusable Kling element ids, for subject consistency across generations.
</ParamField>

<ParamField body="multi_prompt" type="object[]">
  Ordered shot definitions, used when `multi_shots` is true. 1-6 shots; the per-shot durations are bounded by the task's own total duration, which is not expressible here.
</ParamField>

<ParamField body="multi_prompt[].duration" type="integer">
  Duration of this shot in seconds, 1-15. The sum across shots must not exceed the task's total duration, which JSON Schema cannot express; Higgsfield enforces it.

  Range: `1` to `15`
</ParamField>

<ParamField body="multi_prompt[].prompt" type="string">
  Prompt for this shot. Higgsfield documents a 512-character ceiling.
</ParamField>

<ParamField body="multi_shots" type="boolean" default="false">
  Enable a multi-shot sequence. When true, `multi_prompt` carries the per-shot definitions.
</ParamField>

<ParamField body="prompt" type="string">
  Prompt describing the desired output. Higgsfield documents that Kling uses up to the first 2,500 characters and truncates beyond that, so no maxLength is declared — a longer body is accepted, not refused.
</ParamField>

<ParamField body="sound" type="string" default="&#x22;on&#x22;">
  Enable or disable generated sound.

  Possible values: `on`, `off`
</ParamField>

Generated from the schema Router serves at `GET /v2/models/higgsfield/higgsfield-kling-3-pro/openapi.json`, the same document it validates a call against before the request reaches the provider.

### Output

<ResponseField name="cancel_url" type="string">
  Absolute URL used to cancel a request before processing starts.
</ResponseField>

<ResponseField name="error" type="string">
  Failure detail, set when `status` is `failed`.
</ResponseField>

<ResponseField name="request_id" type="string" required>
  Stable identifier used for polling, cancellation and support.
</ResponseField>

<ResponseField name="status" type="string" required>
  Current request state.

  Possible values: `queued`, `in_progress`, `nsfw`, `failed`, `completed`, `canceled`
</ResponseField>

<ResponseField name="status_url" type="string">
  Absolute URL to poll until the request reaches a terminal state.
</ResponseField>

<ResponseField name="video" type="object">
  One Higgsfield media output.
</ResponseField>

<ResponseField name="video.url" type="string" required>
  Download URL of the generated media.
</ResponseField>

## Examples

### Input

```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"
}
```

### Output

```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"
  }
}
```

## Before you ship

The SDKs create an `Idempotency-Key` and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an `X-Comfy-Error-Type` response header explaining why. A `422` means Router rejected the input before calling the provider, and a `413` means the request body was larger than Router accepts. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

Any size limit named in a field description above is the provider's own bound on that field, quoted from the provider's specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see [request body size](/development/comfy-router/limitations#request-bodies-are-capped).

This page documents one partner model called through Comfy Router. The same `comfy-sdk` / `@comfyorg/sdk` package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, with `client.workflows`, `client.assets` and `client.jobs`. See [Comfy SDKs](/development/api-development/sdks).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/api">
    Model discovery, validation errors, retries, and billing.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>