> ## 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 で Kling V3 を使用する

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

`kling/kling-v3` の 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 のスニペットは、raw HTTP 経由の同じ呼び出しです。

**モデル ID:** `kling/kling-v3`

**エンドポイント:** `POST https://api.comfy.org/v2/models/kling/kling-v3`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等キーを作成し、自動リトライ時に再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "kling/kling-v3",
>         {
>             "aspect_ratio": "16:9",
>             "duration": "5",
>             "mode": "std",
>             "prompt": "A red fox trotting through falling snow, cinematic lighting.",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等キーを作成し、自動リトライ時に再利用します。
> const { data } = await comfy.models.run("kling/kling-v3", {
>   aspect_ratio: "16:9",
>   duration: "5",
>   mode: "std",
>   prompt: "A red fox trotting through falling snow, cinematic lighting.",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/kling/kling-v3 \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"std\", \"prompt\": \"A red fox trotting through falling snow, cinematic lighting.\"}"
> ```

> [tab] キューに送信して後で取得
>
> 同じボディを `POST https://api.comfy.org/v2/models/kling/kling-v3/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。[キュー配信](https://docs.comfy.org/ja/development/comfy-router/queue.md) では、ステータス、キャンセル、結果の取得について説明しています。
>
> ```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/kling-v3",
>             {
>                 "aspect_ratio": "16:9",
>                 "duration": "5",
>                 "mode": "std",
>                 "prompt": "A red fox trotting through falling snow, cinematic lighting.",
>             },
>         )
>         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/kling-v3", {
>   aspect_ratio: "16:9",
>   duration: "5",
>   mode: "std",
>   prompt: "A red fox trotting through falling snow, cinematic lighting.",
> });
> 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/kling-v3/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"std\", \"prompt\": \"A red fox trotting through falling snow, cinematic lighting.\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/kling/kling-v3/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 取得。モデルのネイティブ出力とともに 200、まだ実行中であればステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/kling/kling-v3/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## 提供プロバイダー

このモデルは、リクエストで別のプロバイダーを指定しない限り、Comfy Router が直接提供します。以下のプロバイダーも、同じエンドポイントと同じモデル ID でこのモデルを提供しており、`model_provider` クエリパラメータで選択します。

* **Comfy**（デフォルト）: `POST https://api.comfy.org/v2/models/kling/kling-v3`
* **Higgsfield**、`higgsfield/higgsfield-kling-3-std` として: `POST https://api.comfy.org/v2/models/kling/kling-v3?model_provider=higgsfield`
* **Tencent**: `POST https://api.comfy.org/v2/models/kling/kling-v3?model_provider=tencent`
  * 制限: 720P、無音。3〜15 秒（デフォルト 5）。アスペクト比は 16:9、9:16、1:1
  * `invalid_input` で拒否される項目: `image`、`image_tail`、`sound: "on"`、`std` 以外の `mode`（例: `"pro"`）、`multi_shot`、`multi_prompt`、`shot_type`
  * フォールバック: Tencent が失敗した場合、リクエストは Kling（デフォルトのプロバイダー）で 1 回再試行されます。オプトアウトするには `fallback_provider=false` を送信してください。拒否された入力と BYOK リクエストはフォールバックしません。

`strict_mode` のデフォルトは false であるため、Router はこのページに記載されているネイティブのリクエストボディをプロバイダー独自のスキーマに変換し、レスポンスを元の形式に変換して返します。API リファレンスの [`model_provider`、`strict_mode`、`fallback_provider`](https://docs.comfy.org/ja/development/comfy-router/reference#post-v2modelsprovidermodel) を参照し、この方法でルーティングされるすべてのモデルについては[提供プロバイダー](https://docs.comfy.org/ja/development/comfy-router/providers.md)を参照してください。

## スキーマ

### 入力

**aspect\_ratio** `string` (default: "16:9")

ビデオのアスペクト比

指定可能な値: `16:9`、`9:16`、`1:1`

**callback\_url** `string (uri)`

コールバック通知先のアドレス。無視されます: comfy-api は転送前にこのフィールドを破棄します。Comfy Router がユーザーに代わってポーリングします。

形式: `uri`

**camera\_control** `object`

**camera\_control.config** `object`

**camera\_control.config.horizontal** `number`

カメラの水平軸（x軸）に沿った移動を制御します。負の値は左、正の値は右を示します。

範囲: `-10` から `10`

**camera\_control.config.pan** `number`

垂直面内でのカメラの回転（x軸）を制御します。負の値は下向きの回転、正の値は上向きの回転を示します。

範囲: `-10` から `10`

**camera\_control.config.roll** `number`

カメラのロール量（z軸）を制御します。負の値は反時計回り、正の値は時計回りを示します。

範囲: `-10` から `10`

**camera\_control.config.tilt** `number`

水平面内でのカメラの回転（y軸）を制御します。負の値は左への回転、正の値は右への回転を示します。

範囲: `-10` から `10`

**camera\_control.config.vertical** `number`

カメラの垂直軸（y軸）に沿った移動を制御します。負の値は下方向、正の値は上方向を示します。

範囲: `-10` から `10`

**camera\_control.config.zoom** `number`

カメラの焦点距離の変化を制御します。負の値はより狭い視野、正の値はより広い視野を示します。

範囲: `-10` から `10`

**camera\_control.type** `string`

定義済みのカメラ動作タイプ。simple: カスタマイズ可能なカメラ動作。down\_back: カメラが下降しながら後退します。forward\_up: カメラが前進しながら上方向にチルトします。right\_turn\_forward: 右に回転して前進します。left\_turn\_forward: 左に回転して前進します。

指定可能な値: `simple`、`down_back`、`forward_up`、`right_turn_forward`、`left_turn_forward`

**cfg\_scale** `number` (default: 0.5)

ビデオ生成における柔軟性。値が高いほどモデルの柔軟性の度合いが低くなり、ユーザーのプロンプトへの関連性が強くなります。

範囲: `0` から `1`

形式: `float`

**duration** `string` (default: "5")

ビデオの長さ（秒）

指定可能な値: `3`、`4`、`5`、`6`、`7`、`8`、`9`、`10`、`11`、`12`、`13`、`14`、`15`

**external\_task\_id** `string`

カスタマイズされたタスク ID。無視されます: comfy-api は転送前にこのフィールドを破棄します。Comfy Router がユーザーに代わってポーリングします。

**model\_name** `string`

モデル名。Comfy Router を使用する場合は、省略するか null を送信します。モデルはリクエストパスによって選択されます。名前を指定する場合は、そのパスと一致している必要があります。

**multi\_prompt** `object[]`

プロンプトや再生時間など、各ストーリーボードに関する情報。最大6個、最小1個のストーリーボードをサポートします。multi\_shot が true かつ shot\_type が customize の場合に必須です。

**multi\_prompt\[].duration** `string`

このストーリーボードの再生時間（秒）。タスク全体の再生時間を超えてはならず、1 未満にすることもできません。すべてのストーリーボードの再生時間の合計は、タスク全体の再生時間と等しくなります。

**multi\_prompt\[].index** `integer`

ショットの連番

**multi\_prompt\[].prompt** `string`

このストーリーボードのプロンプト。最大長は 512 文字です。

**multi\_shot** `boolean` (default: false)

マルチショットビデオを生成するかどうか。true の場合、prompt パラメータは無効です。false の場合、shot\_type と multi\_prompt パラメータは無効です。

**negative\_prompt** `string`

ネガティブテキストプロンプト。ネガティブプロンプトの情報は、ポジティブプロンプト内に直接ネガティブな文を記述して補足することが推奨されます。

**prompt** `string`

ポジティブテキストプロンプト。voice\_list パラメータの順序に対応する音声を指定するには、\<\<\<voice\_1>>> を使用します。1つのタスクで最大2つの音声を参照できます。音声を指定する場合、sound パラメータの値は on である必要があります。

**shot\_type** `string`

ストーリーボードの方法。multi\_shot パラメータが true に設定されている場合に必須です。

指定可能な値: `customize`、`intelligence`

**sound** `string` (default: "off")

ビデオを生成するときに同時にサウンドを生成するかどうか。このパラメータをサポートするのは V2.6 以降のモデルのみです。

指定可能な値: `on`、`off`

**voice\_list** `object[]`

ビデオ生成時に参照する音声のリスト。最大2つの音声をサポートします。リストの順に `prompt` 内で \<\<\<voice\_1>>> および \<\<\<voice\_2>>> として参照します。`sound` を "on" に設定する必要があります。これをサポートするのは V2.6 以降のモデルのみです。以前のモデルの場合、または `sound` がデフォルトの "off" のままの場合は、音声は適用されません。

**voice\_list\[].voice\_id** `string` *required*

音声カスタマイズ API を通じて返される音声 ID、またはシステムプリセットの音声 ID。

**watermark\_info** `object`

透かし入りの結果を同時に生成するかどうか。現時点ではカスタム透かしはサポートされていません。

**watermark\_info.enabled** `boolean`

true は透かしを生成することを意味し、false は生成しないことを意味します。

**image** `string`

参照画像 - URL または Base64 エンコード文字列。10MB を超えることはできず、解像度は 300\*300px 以上、アスペクト比は 1:2.5 ～ 2.5:1 の範囲である必要があります。Base64 には data:image というプレフィックスを含めないでください。

**image\_tail** `string`

参照画像 - 終了フレーム制御。URL または Base64 エンコード文字列。10MB を超えることはできず、解像度は 300\*300px 以上である必要があります。Base64 には data:image プレフィックスを含めないでください。dynamic\_masks/static\_mask または camera\_control とは同時に使用できません。

**mode** `string` (default: "std")

動画生成モード。std: コスト効率に優れたスタンダードモード。pro: プロフェッショナルモード。より長い再生時間の動画を、より高品質な出力で生成します。4k: 4K解像度の動画を生成するウルトラHDモード。このモデルファミリーで 4k をサポートするのは kling-v3 のみです。その他の Kling テキストから動画へのモデルは pro/std のみに対応します。

指定可能な値: `std`, `pro`, `4k`

これは Router が `GET /v2/models/kling/kling-v3/openapi.json` で提供するスキーマから生成されており、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるものと同じドキュメントです。

### 出力

**code** `integer`

エラーコード

**data** `object`

**data.created\_at** `integer`

タスクの作成時間、Unix タイムスタンプ（ミリ秒）

**data.final\_unit\_deduction** `string`

タスクの控除ユニット数

**data.task\_id** `string`

タスク ID

**data.task\_info** `object`

**data.task\_info.external\_task\_id** `string`

**data.task\_result** `object`

**data.task\_result.videos** `object[]`

**data.task\_result.videos\[].duration** `string`

ビデオの合計再生時間（秒）

**data.task\_result.videos\[].id** `string`

生成されたビデオの ID

**data.task\_result.videos\[].url** `string (uri)`

生成されたビデオの URL

形式: `uri`

**data.task\_result.videos\[].watermark\_url** `string (uri)`

ウォーターマーク付きの生成されたビデオの URL（ホットリンク保護形式）

形式: `uri`

**data.task\_status** `string`

タスクのステータス

取り得る値: `submitted`、`processing`、`succeed`、`failed`

**data.task\_status\_msg** `string`

タスクのステータス情報。タスクが失敗した場合は失敗理由を表示します

**data.updated\_at** `integer`

タスクの更新時間、Unix タイムスタンプ（ミリ秒）

**data.watermark\_info** `object`

**data.watermark\_info.enabled** `boolean`

**message** `string`

エラーメッセージ

**request\_id** `string`

リクエスト ID

## 例

### 入力

```json theme={null}
{
  "aspect_ratio": "16:9",
  "duration": "5",
  "mode": "std",
  "prompt": "A red fox trotting through falling snow, cinematic lighting."
}
```

### 出力

```json theme={null}
{
  "code": 0,
  "data": {
    "created_at": 1798761600000,
    "task_id": "kling-task-1a2b3c4d5e6f",
    "task_result": {
      "videos": [
        {
          "duration": "5",
          "id": "kling-video-6f5e4d3c2b1a",
          "url": "https://example.invalid/kling/kling-v2-5-turbo/generated.mp4"
        }
      ]
    },
    "task_status": "succeed",
    "task_status_msg": "",
    "updated_at": 1798761840000
  },
  "message": "SUCCEED",
  "request_id": "9f2c1a04-7b6e-4d38-8a51-3c0e7d9b2f46"
}
```

## 出荷前の確認

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

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

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

このページは、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](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.