> ## Documentation Index
> Fetch the complete documentation index at: https://comfyuiwiki.com/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?onboarding=router)でキーを作成し、`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 defaultTabIndex={1}>
  <Tab title="結果を待つ">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # 環境変数から COMFY_API_KEY を読み取ります。
      # SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。
      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";

      // 環境変数から COMFY_API_KEY を読み取ります。
      // SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。
      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="キューに送信して後で収集">
    同じボディを `POST https://api.comfy.org/v2/models/kling/videos-avatar-image2video/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。[キュー配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、結果の取得の流れを順を追って説明します。

    <CodeGroup>
      ```python Python theme={null}
      import asyncio
      from comfy_sdk import AsyncComfy

      # 環境変数から COMFY_API_KEY を読み取ります。
      # 各 submit() 呼び出しは自身の Idempotency-Key を発行し、自動リトライのために再利用します。
      async def main():
          async with AsyncComfy() as client:
              handle = await 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)  # モデル ID と合わせて、別のプロセスに必要なものはこれだけです

              # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
              async for update in handle.iter_events():
                  print(update.status, update.queue_position)

              # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。
              # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。
              result = await handle.get()

          print(result)

      asyncio.run(main())
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // 環境変数から COMFY_API_KEY を読み取ります。
      // 各 submit() 呼び出しは自身の Idempotency-Key を発行し、自動リトライのために再利用します。
      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); // モデル ID と合わせて、別のプロセスに必要なものはこれだけです

      // リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
      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. ステータスが COMPLETED になるまでポーリングし、各レスポンスが示す Retry-After 秒だけ待機します。
      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. 取得。モデル固有の出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
      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 エンコードまたは画像 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 が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](/ja/development/comfy-router/reference#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](/ja/development/comfy-router/limitations) を参照してください。

このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ `comfy-sdk` / `@comfyorg/sdk` パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: `Comfy(api_key=...)` / `new Comfy({ apiKey })`、および `client.workflows`、`client.assets`、`client.jobs`。[Comfy SDKs](/ja/development/api-development/sdks) を参照してください。

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

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

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