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

# 通过 Comfy Router 使用视频唇形同步

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

`kling/videos-lip-sync` 的 API 参考，由 Comfy Router 从 Kling 提供。

## 快速开始

在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys)中创建密钥，并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK（`pip install comfy-sdk`、`npm install @comfyorg/sdk`）；cURL 代码片段则是通过原始 HTTP 发起的同一个调用。

**模型 ID：** `kling/videos-lip-sync`

**端点：** `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">
    <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>

## 数据结构

### 输入

<ParamField body="callback_url" type="string (uri)">
  回调通知地址。任务状态发生变化时，服务器会发出通知。

  格式：`uri`
</ParamField>

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

<ParamField body="input.audio_file" type="string">
  音频文件的本地路径。支持的格式：.mp3/.wav/.m4a/.aac，最大文件大小为 5MB。Base64 编码。
</ParamField>

<ParamField body="input.audio_type" type="string">
  用于对口型的音频文件传输方法。当 mode 为 audio2video 时必填。

  可选值：`file`、`url`
</ParamField>

<ParamField body="input.audio_url" type="string">
  音频文件下载 URL。支持的格式：.mp3/.wav/.m4a/.aac，最大文件大小为 5MB。
</ParamField>

<ParamField body="input.mode" type="string" required>
  视频生成模式。text2video：文生视频生成模式；audio2video：音频生视频生成模式

  可选值：`text2video`、`audio2video`
</ParamField>

<ParamField body="input.text" type="string">
  用于对口型视频生成的文本内容。当 mode 为 text2video 时必填。最大长度为 120 个字符。
</ParamField>

<ParamField body="input.video_id" type="string">
  由 Kling AI 已生成视频的 ID。仅支持最近 30 天内已生成的 5 秒和 10 秒视频。
</ParamField>

<ParamField body="input.video_url" type="string">
  获取上传视频的链接。视频文件支持 .mp4/.mov，文件大小不超过 100MB，视频时长在 2-10 秒之间。
</ParamField>

<ParamField body="input.voice_id" type="string">
  音色 ID。当 mode 为 text2video 时必填。系统提供多种音色可供选择。
</ParamField>

<ParamField body="input.voice_language" type="string" default="&#x22;en&#x22;">
  音色语言，与音色 ID 相对应。

  可选值：`zh`、`en`
</ParamField>

<ParamField body="input.voice_speed" type="number" default="1">
  语速。有效范围：0.8\~2.0，精确到小数点后一位。

  范围：`0.8` 到 `2`
</ParamField>

该文档根据 Router 在 `GET /v2/models/kling/videos-lip-sync/openapi.json` 提供的 schema 生成，也是请求到达提供商之前用于校验调用的同一份文档。

### 输出

<ResponseField name="code" type="integer">
  错误码
</ResponseField>

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

<ResponseField name="data.created_at" type="integer">
  任务创建时间，Unix 时间戳（毫秒）
</ResponseField>

<ResponseField name="data.final_unit_deduction" type="string">
  任务的扣费单位
</ResponseField>

<ResponseField name="data.task_id" type="string">
  任务 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">
  视频总时长，单位为秒
</ResponseField>

<ResponseField name="data.task_result.videos[].id" type="string">
  已生成视频的 ID
</ResponseField>

<ResponseField name="data.task_result.videos[].url" type="string (uri)">
  已生成视频的 URL

  格式：`uri`
</ResponseField>

<ResponseField name="data.task_result.videos[].watermark_url" type="string (uri)">
  已生成视频的带水印 URL，防盗链格式

  格式：`uri`
</ResponseField>

<ResponseField name="data.task_status" type="string">
  任务状态

  可选值：`submitted`、`processing`、`succeed`、`failed`
</ResponseField>

<ResponseField name="data.updated_at" type="integer">
  任务更新时间，Unix 时间戳（毫秒）
</ResponseField>

<ResponseField name="message" type="string">
  报错信息
</ResponseField>

<ResponseField name="request_id" type="string">
  请求 ID
</ResponseField>

## 示例

### 输入

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

### 输出

```json theme={null}
{
  "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"
}
```

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载，因为[结果链接会过期](/zh/development/comfy-router/reference#结果资产)。

<CardGroup cols={3}>
  <Card title="请求头" icon="list" href="/zh/development/comfy-router/quickstart">
    身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
  </Card>

  <Card title="使用 Router API" icon="code" href="/zh/development/comfy-router/quickstart">
    模型发现、校验错误、重试与计费。
  </Card>

  <Card title="限制" icon="triangle-exclamation" href="/zh/development/comfy-router/limitations">
    Router 目前不支持的功能，以及替代方案。
  </Card>
</CardGroup>