> ## 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 で Videos Avatar Image 2video を使用する

> Comfy Router 経由で kling/videos-avatar-image2video を呼び出します: エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。

`kling/videos-avatar-image2video` の API リファレンス。Kling から Comfy Router によって提供されます。

## クイックスタート

[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-avatar-image2video`

**エンドポイント:** `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>

## Schema

### 入力

<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 エンコードまたは画像 URL をサポートします。対応形式: .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` で提供するスキーマから生成されており、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるドキュメントと同じものです。

### 出力

<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` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を示す `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは [結果 URL の有効期限](/ja/development/comfy-router/reference#結果アセット) があるため、早めにダウンロードしてください。

<CardGroup cols={3}>
  <Card title="ヘッダー" icon="list" href="/ja/development/comfy-router/quickstart">
    認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
  </Card>

  <Card title="Router API の利用" icon="code" href="/ja/development/comfy-router/quickstart">
    モデルの検出、バリデーションエラー、リトライ、課金。
  </Card>

  <Card title="制限事項" icon="triangle-exclamation" href="/ja/development/comfy-router/limitations">
    Router が現在対応していないことと、代替手段。
  </Card>
</CardGroup>