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

# 配合 Comfy Router 使用 Videos Avatar Image 2video

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

由 Comfy Router 从 Kling 提供的 `kling/videos-avatar-image2video` API 参考。

## 快速开始

在[你的 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 执行的同一调用。

**Model ID:** `kling/videos-avatar-image2video`

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

<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-avatar-image2video",
              {
                  "image": "https://example.invalid/kling/avatar.png",
                  "mode": "std",
                  "prompt": "The presenter smiles and gestures towards the camera.",
                  "sound_file": "https://example.invalid/kling/voice.mp3",
              },
          )

      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-avatar-image2video", {
        image: "https://example.invalid/kling/avatar.png",
        mode: "std",
        prompt: "The presenter smiles and gestures towards the camera.",
        sound_file: "https://example.invalid/kling/voice.mp3",
      });

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/kling/videos-avatar-image2video \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image\": \"https://example.invalid/kling/avatar.png\", \"mode\": \"std\", \"prompt\": \"The presenter smiles and gestures towards the camera.\", \"sound_file\": \"https://example.invalid/kling/voice.mp3\"}"
      ```
    </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-avatar-image2video",
              {
                  "image": "https://example.invalid/kling/avatar.png",
                  "mode": "std",
                  "prompt": "The presenter smiles and gestures towards the camera.",
                  "sound_file": "https://example.invalid/kling/voice.mp3",
              },
          )
          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-avatar-image2video", {
        image: "https://example.invalid/kling/avatar.png",
        mode: "std",
        prompt: "The presenter smiles and gestures towards the camera.",
        sound_file: "https://example.invalid/kling/voice.mp3",
      });
      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-avatar-image2video/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"image\": \"https://example.invalid/kling/avatar.png\", \"mode\": \"std\", \"prompt\": \"The presenter smiles and gestures towards the camera.\", \"sound_file\": \"https://example.invalid/kling/voice.mp3\"}"

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

## 数据结构

### 输入

<ParamField body="audio_id" type="string">
  通过 TTS API 生成的音频 ID。仅支持最近 30 天内生成的 2-300 秒音频。audio\_id 与 sound\_file 必须提供其中之一（互斥）。
</ParamField>

<ParamField body="callback_url" type="string (uri)">
  本任务结果的回调通知地址。

  格式：`uri`
</ParamField>

<ParamField body="external_task_id" type="string">
  自定义任务 ID。在单个用户账户内必须唯一。
</ParamField>

<ParamField body="image" type="string" required>
  数字人参考图像。支持 Base64 编码或图片网址。支持格式：.jpg/.jpeg/.png。最大值 10MB，宽度/高度最小值 300px，宽高比介于 1:2.5 与 2.5:1 之间。
</ParamField>

<ParamField body="mode" type="string" default="&#x22;std&#x22;">
  视频生成模式。std：标准模式（性价比高），pro：专业模式（时长更长、质量更高）。

  可选值：`std`、`pro`
</ParamField>

<ParamField body="prompt" type="string">
  正向文本提示词。可定义数字人操作、情绪和相机运动。
</ParamField>

<ParamField body="sound_file" type="string">
  声音文件。支持 Base64 编码的音频或可访问的音频 URL。接受的格式：.mp3/.wav/.m4a/.aac（最大值 5MB），2-300 秒。audio\_id 与 sound\_file 必须提供其中之一（互斥）。
</ParamField>

<ParamField body="watermark_info" type="object" />

<ParamField body="watermark_info.enabled" type="boolean">
  是否同时生成带水印的结果。
</ParamField>

根据 Router 在 `GET /v2/models/kling/videos-avatar-image2video/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.task_status_msg" type="string">
  任务状态信息，任务失败时显示失败原因
</ResponseField>

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

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

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

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

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

## 示例

### 输入

```json theme={null}
{
  "image": "https://example.invalid/kling/avatar.png",
  "mode": "std",
  "prompt": "The presenter smiles and gestures towards the camera.",
  "sound_file": "https://example.invalid/kling/voice.mp3"
}
```

### 输出

```json theme={null}
{
  "code": 0,
  "data": {
    "created_at": 1798761600000,
    "task_id": "kling-avatar-task-8b7a6c5d4e3f",
    "task_result": {
      "videos": [
        {
          "duration": "10",
          "id": "kling-video-1c2d3e4f5a6b",
          "url": "https://example.invalid/kling/videos-avatar-image2video/generated.mp4"
        }
      ]
    },
    "task_status": "succeed",
    "task_status_msg": "",
    "updated_at": 1798761900000
  },
  "message": "SUCCEED",
  "request_id": "b41d7c58-9e26-4f03-a7d1-5c8e0b3f2a69"
}
```

## 发布前须知

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>