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

# Use Kling V3 Omni with Comfy Router

> Call kling/kling-v3-omni through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `kling/kling-v3-omni`, served by Comfy Router from Kling.

## 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 and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk`, `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `kling/kling-v3-omni`

**Endpoint:** `POST https://api.comfy.org/v2/models/kling/kling-v3-omni`

<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(
              "kling/kling-v3-omni",
              {
                  "aspect_ratio": "16:9",
                  "duration": "5",
                  "mode": "pro",
                  "prompt": "A paper boat drifting down a rain-soaked street at dusk.",
              },
          )

      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("kling/kling-v3-omni", {
        aspect_ratio: "16:9",
        duration: "5",
        mode: "pro",
        prompt: "A paper boat drifting down a rain-soaked street at dusk.",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/kling/kling-v3-omni \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"pro\", \"prompt\": \"A paper boat drifting down a rain-soaked street at dusk.\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    <Note>
      Queued delivery is rolling out per workspace. Until yours is enabled, the submit route answers `403` with `X-Comfy-Error-Type: not_enabled`. Nothing about the request is wrong, and the same body works through the synchronous route in the meantime.
    </Note>

    The same body, sent to `POST https://api.comfy.org/v2/models/kling/kling-v3-omni/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(
              "kling/kling-v3-omni",
              {
                  "aspect_ratio": "16:9",
                  "duration": "5",
                  "mode": "pro",
                  "prompt": "A paper boat drifting down a rain-soaked street at dusk.",
              },
          )
          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("kling/kling-v3-omni", {
        aspect_ratio: "16:9",
        duration: "5",
        mode: "pro",
        prompt: "A paper boat drifting down a rain-soaked street at dusk.",
      });
      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);
      ```

      ```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/kling/kling-v3-omni/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"pro\", \"prompt\": \"A paper boat drifting down a rain-soaked street at dusk.\"}"

      # 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/kling/kling-v3-omni/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/kling/kling-v3-omni/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### Input

<ParamField body="aspect_ratio" type="string">
  The aspect ratio of the generated video frame (width:height). Required when first-frame reference or video editing features are not used.

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

<ParamField body="callback_url" type="string (uri)">
  The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes.

  Format: `uri`
</ParamField>

<ParamField body="duration" type="string" default="&#x22;5&#x22;">
  Video Length in seconds. When using video editing function (refer\_type: base), output duration is the same as input video and this parameter is invalid.

  Possible values: `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`
</ParamField>

<ParamField body="element_list" type="object[]">
  Reference Element List based on element ID configuration.
</ParamField>

<ParamField body="element_list[].element_id" type="integer" required>
  Element ID

  Format: `int64`
</ParamField>

<ParamField body="external_task_id" type="string">
  Customized Task ID. Must be unique within a single user account.
</ParamField>

<ParamField body="image_list" type="object[]">
  Reference Image List. Can include reference images of the element, scene, style, etc., or be used as the first or last frame to generate videos.
</ParamField>

<ParamField body="image_list[].image_url" type="string">
  Image Base64 encoding or image URL (ensure accessibility). Supported formats include .jpg/.jpeg/.png. File size cannot exceed 10MB. Width and height dimensions shall not be less than 300px, aspect ratio between 1:2.5 \~ 2.5:1.
</ParamField>

<ParamField body="image_list[].type" type="string">
  Whether the image is in the first or last frame. first\_frame is the first frame, end\_frame is the last frame. Currently does not support only the end frame.

  Possible values: `first_frame`, `end_frame`
</ParamField>

<ParamField body="mode" type="string" default="&#x22;pro&#x22;">
  Video generation mode. std: Standard Mode, generating 720P videos, cost-effective. pro: Professional Mode, generating 1080P videos, higher quality video output.

  Possible values: `pro`, `std`
</ParamField>

<ParamField body="model_name" type="string">
  Model name. Omit it or send null when using Comfy Router; the model is selected by the request path. A supplied name must match that path.
</ParamField>

<ParamField body="multi_prompt" type="object[]">
  Information about each storyboard, such as prompts and duration. Supports up to 6 storyboards, with a minimum of 1. Required when multi\_shot is true and shot\_type is customize.
</ParamField>

<ParamField body="multi_prompt[].duration" type="string">
  Duration of this storyboard in seconds. Must not exceed total task duration and must not be less than 1. Sum of all storyboard durations equals total task duration.
</ParamField>

<ParamField body="multi_prompt[].index" type="integer">
  Shot sequence number
</ParamField>

<ParamField body="multi_prompt[].prompt" type="string">
  Prompt word for this storyboard. Maximum length 512 characters.
</ParamField>

<ParamField body="multi_shot" type="boolean" default="false">
  Whether to generate multi-shot video. When true, the prompt parameter is invalid. When false, the shot\_type and multi\_prompt parameters are invalid.
</ParamField>

<ParamField body="prompt" type="string">
  Text prompt words, which can include positive and negative descriptions. Must not exceed 2,500 characters. Can specify elements, images, or videos in the format \<\<\<>>> such as \<\<element\_1>>, \<\<\<image\_1>>>, \<\<\<video\_1>>>.
</ParamField>

<ParamField body="shot_type" type="string">
  Storyboard method. Required when the multi\_shot parameter is set to true.

  Possible values: `customize`, `intelligence`
</ParamField>

<ParamField body="sound" type="string" default="&#x22;off&#x22;">
  Whether sound is generated simultaneously when generating videos.

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

<ParamField body="video_list" type="object[]">
  Reference Video list. Can be used as a reference video for feature or as a video to be edited, with the default being the video to be edited.
</ParamField>

<ParamField body="video_list[].keep_original_sound" type="string">
  Whether to keep the video original sound. yes indicates retention, no indicates non retention.

  Possible values: `yes`, `no`
</ParamField>

<ParamField body="video_list[].refer_type" type="string">
  Reference video type. feature is the feature reference video, base is the video to be edited.

  Possible values: `feature`, `base`
</ParamField>

<ParamField body="video_list[].video_url" type="string" required>
  URL of uploaded video. Only .mp4/.mov formats are supported. Duration between 3-10 seconds. Resolution must be between 720px and 2160px. Frame rates of 24-60 fps supported. Only 1 video can be uploaded, with size not exceeding 200MB.
</ParamField>

<ParamField body="watermark_info" type="object">
  Whether to generate watermarked results simultaneously. Custom watermark is not supported at this time.
</ParamField>

<ParamField body="watermark_info.enabled" type="boolean">
  true means generate watermark, false means do not generate.
</ParamField>

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

### Output

<ResponseField name="code" type="integer">
  Error code
</ResponseField>

<ResponseField name="data" type="object" />

<ResponseField name="data.created_at" type="integer">
  Task creation time, Unix timestamp in milliseconds
</ResponseField>

<ResponseField name="data.final_unit_deduction" type="string">
  The deduction units of task
</ResponseField>

<ResponseField name="data.task_id" type="string">
  Task ID
</ResponseField>

<ResponseField name="data.task_info" type="object" />

<ResponseField name="data.task_info.external_task_id" type="string" />

<ResponseField name="data.task_result" type="object" />

<ResponseField name="data.task_result.videos" type="object[]" />

<ResponseField name="data.task_result.videos[].duration" type="string">
  Total video duration in seconds
</ResponseField>

<ResponseField name="data.task_result.videos[].id" type="string">
  Generated video ID
</ResponseField>

<ResponseField name="data.task_result.videos[].url" type="string (uri)">
  URL for generated video

  Format: `uri`
</ResponseField>

<ResponseField name="data.task_result.videos[].watermark_url" type="string (uri)">
  URL for generated video with watermark, hotlink protection format

  Format: `uri`
</ResponseField>

<ResponseField name="data.task_status" type="string">
  Task Status

  Possible values: `submitted`, `processing`, `succeed`, `failed`
</ResponseField>

<ResponseField name="data.task_status_msg" type="string">
  Task status information, displaying the failure reason when the task fails
</ResponseField>

<ResponseField name="data.updated_at" type="integer">
  Task update time, Unix timestamp in milliseconds
</ResponseField>

<ResponseField name="data.watermark_info" type="object" />

<ResponseField name="data.watermark_info.enabled" type="boolean" />

<ResponseField name="message" type="string">
  Error message
</ResponseField>

<ResponseField name="request_id" type="string">
  Request ID
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "aspect_ratio": "16:9",
  "duration": "5",
  "mode": "pro",
  "prompt": "A paper boat drifting down a rain-soaked street at dusk."
}
```

### Output

```json theme={null}
{
  "code": 0,
  "data": {
    "created_at": 1798761600000,
    "task_id": "kling-task-1a2b3c4d5e6f",
    "task_result": {
      "videos": [
        {
          "duration": "5",
          "id": "kling-video-6f5e4d3c2b1a",
          "url": "https://example.invalid/kling/kling-v1/generated.mp4"
        }
      ]
    },
    "task_status": "succeed",
    "task_status_msg": "",
    "updated_at": 1798761840000
  },
  "message": "SUCCEED",
  "request_id": "9f2c1a04-7b6e-4d38-8a51-3c0e7d9b2f46"
}
```

## 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. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

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