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

# Use Videos Lip Sync with Comfy Router

> Call kling/videos-lip-sync through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for `kling/videos-lip-sync`, 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/videos-lip-sync`

**Endpoint:** `POST https://api.comfy.org/v2/models/kling/videos-lip-sync`

<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/videos-lip-sync",
              {
                  "input": {
                      "mode": "text2video",
                      "text": "Welcome to Comfy Cloud.",
                      "video_id": "kling-video-6f5e4d3c2b1a",
                      "voice_id": "genshin_vindi2",
                      "voice_language": "en",
                      "voice_speed": 1,
                  },
              },
          )

      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/videos-lip-sync", {
        input: {
          mode: "text2video",
          text: "Welcome to Comfy Cloud.",
          video_id: "kling-video-6f5e4d3c2b1a",
          voice_id: "genshin_vindi2",
          voice_language: "en",
          voice_speed: 1,
        },
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/kling/videos-lip-sync \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input\": {\"mode\":\"text2video\",\"text\":\"Welcome to Comfy Cloud.\",\"video_id\":\"kling-video-6f5e4d3c2b1a\",\"voice_id\":\"genshin_vindi2\",\"voice_language\":\"en\",\"voice_speed\":1}}"
      ```
    </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/videos-lip-sync/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/videos-lip-sync",
              {
                  "input": {
                      "mode": "text2video",
                      "text": "Welcome to Comfy Cloud.",
                      "video_id": "kling-video-6f5e4d3c2b1a",
                      "voice_id": "genshin_vindi2",
                      "voice_language": "en",
                      "voice_speed": 1,
                  },
              },
          )
          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/videos-lip-sync", {
        input: {
          mode: "text2video",
          text: "Welcome to Comfy Cloud.",
          video_id: "kling-video-6f5e4d3c2b1a",
          voice_id: "genshin_vindi2",
          voice_language: "en",
          voice_speed: 1,
        },
      });
      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/videos-lip-sync/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input\": {\"mode\":\"text2video\",\"text\":\"Welcome to Comfy Cloud.\",\"video_id\":\"kling-video-6f5e4d3c2b1a\",\"voice_id\":\"genshin_vindi2\",\"voice_language\":\"en\",\"voice_speed\":1}}"

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

## Schema

### Input

<ParamField body="callback_url" type="string (uri)">
  The callback notification address. Server will notify when the task status changes.

  Format: `uri`
</ParamField>

<ParamField body="input" type="object" required />

<ParamField body="input.audio_file" type="string">
  Local Path of Audio File. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB. Base64 code.
</ParamField>

<ParamField body="input.audio_type" type="string">
  Method of Transmitting Audio Files for Lip-Sync. Required when mode is audio2video.

  Possible values: `file`, `url`
</ParamField>

<ParamField body="input.audio_url" type="string">
  Audio File Download URL. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB.
</ParamField>

<ParamField body="input.mode" type="string" required>
  Video Generation Mode. text2video: Text-to-video generation mode; audio2video: Audio-to-video generation mode

  Possible values: `text2video`, `audio2video`
</ParamField>

<ParamField body="input.text" type="string">
  Text Content for Lip-Sync Video Generation. Required when mode is text2video. Maximum length is 120 characters.
</ParamField>

<ParamField body="input.video_id" type="string">
  The ID of the video generated by Kling AI. Only supports 5-second and 10-second videos generated within the last 30 days.
</ParamField>

<ParamField body="input.video_url" type="string">
  Get link for uploaded video. Video files support .mp4/.mov, file size does not exceed 100MB, video length between 2-10s.
</ParamField>

<ParamField body="input.voice_id" type="string">
  Voice ID. Required when mode is text2video. The system offers a variety of voice options to choose from.
</ParamField>

<ParamField body="input.voice_language" type="string" default="&#x22;en&#x22;">
  The voice language corresponds to the Voice ID.

  Possible values: `zh`, `en`
</ParamField>

<ParamField body="input.voice_speed" type="number" default="1">
  Speech Rate. Valid range: 0.8\~2.0, accurate to one decimal place.

  Range: `0.8` to `2`
</ParamField>

Generated from the schema Router serves at `GET /v2/models/kling/videos-lip-sync/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
</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.updated_at" type="integer">
  Task update time
</ResponseField>

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

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

## Examples

### Input

```json theme={null}
{
  "input": {
    "mode": "text2video",
    "text": "Welcome to Comfy Cloud.",
    "video_id": "kling-video-6f5e4d3c2b1a",
    "voice_id": "genshin_vindi2",
    "voice_language": "en",
    "voice_speed": 1
  }
}
```

### Output

```json theme={null}
{
  "code": 0,
  "data": {
    "created_at": 1798761600000,
    "final_unit_deduction": "1.00",
    "task_id": "kling-lip-sync-task-4f3e2d1c0b9a",
    "task_result": {
      "videos": [
        {
          "duration": "8",
          "id": "kling-video-9a8b7c6d5e4f",
          "url": "https://example.invalid/kling/videos-lip-sync/generated.mp4"
        }
      ]
    },
    "task_status": "succeed",
    "updated_at": 1798761780000
  },
  "message": "SUCCEED",
  "request_id": "5e0a9b17-6d3c-42f8-91b4-7a2c8d6e0f35"
}
```

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