Use Videos Lip Sync with Comfy Router

API Reference for kling/videos-lip-sync, served by Comfy Router from Kling.

Quick start

Create a key in your Comfy workspace 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

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)

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

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

Schema

Input

string (uri)

The callback notification address. Server will notify when the task status changes.Format: uri

object

required

string

Local Path of Audio File. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB. Base64 code.

string

Method of Transmitting Audio Files for Lip-Sync. Required when mode is audio2video.Possible values: file, url

string

Audio File Download URL. Supported formats: .mp3/.wav/.m4a/.aac, maximum file size of 5MB.

string

required

Video Generation Mode. text2video: Text-to-video generation mode; audio2video: Audio-to-video generation modePossible values: text2video, audio2video

string

Text Content for Lip-Sync Video Generation. Required when mode is text2video. Maximum length is 120 characters.

string

The ID of the video generated by Kling AI. Only supports 5-second and 10-second videos generated within the last 30 days.

string

Get link for uploaded video. Video files support .mp4/.mov, file size does not exceed 100MB, video length between 2-10s.

string

Voice ID. Required when mode is text2video. The system offers a variety of voice options to choose from.

string

default:"\"en\""

The voice language corresponds to the Voice ID.Possible values: zh, en

number

default:"1"

Speech Rate. Valid range: 0.8~2.0, accurate to one decimal place.Range: 0.8 to 2

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

integer

Error code

object

integer

Task creation time, Unix timestamp in milliseconds

string

The deduction units of task

string

Task ID

object

string

object

object[]

string

Total video duration in seconds

string

Generated video ID

string (uri)

URL for generated videoFormat: uri

string (uri)

URL for generated video with watermark, hotlink protection formatFormat: uri

string

Task StatusPossible values: submitted, processing, succeed, failed

string

Task status information, displaying the failure reason when the task fails

integer

Task update time, Unix timestamp in milliseconds

object

boolean

string

Error message

string

Request ID

Examples

Input

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

Output

{
  "code": 0,
  "data": {
    "created_at": 1798761600000,
    "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.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.

Develop with Comfy

Deploy ComfyUI

Run Workflows

Comfy Router

Comfy CLI

Specifications

Use Videos Lip Sync with Comfy Router

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship

Headers

Using the Router API

Limitations

​Quick start

​Schema

​Input

​Output

​Examples

​Input

​Output

​Before you ship

Headers

Using the Router API

Limitations

Quick start

Schema

Input

Output

Examples

Input

Output

Before you ship