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

# Kling V3 Omni を Comfy Router で使用する

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

Comfy Router が Kling から提供する `kling/kling-v3-omni` の API リファレンス。

**入力：** テキスト, 画像, ビデオ · **出力：** ビデオ

## クイックスタート

[あなたの 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/kling-v3-omni`

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

> [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-omni",
>         {
>             "aspect_ratio": "16:9",
>             "duration": "5",
>             "mode": "pro",
>             "prompt": "A paper boat drifting down a rain-soaked street at dusk.",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
> const { data } = await comfy.models.run("kling/kling-v3-omni", {
>   aspect_ratio: "16:9",
>   duration: "5",
>   mode: "pro",
>   prompt: "A paper boat drifting down a rain-soaked street at dusk.",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/kling/kling-v3-omni \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5\", \"mode\": \"pro\", \"prompt\": \"A paper boat drifting down a rain-soaked street at dusk.\"}"
> ```

> [tab] キューに送信して後で取得
>
> 同じボディを `POST https://api.comfy.org/v2/models/kling/kling-v3-omni/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-omni",
>             {
>                 "aspect_ratio": "16:9",
>                 "duration": "5",
>                 "mode": "pro",
>                 "prompt": "A paper boat drifting down a rain-soaked street at dusk.",
>             },
>         )
>         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-omni", {
>   aspect_ratio: "16:9",
>   duration: "5",
>   mode: "pro",
>   prompt: "A paper boat drifting down a rain-soaked street at dusk.",
> });
> 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-omni/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\": \"pro\", \"prompt\": \"A paper boat drifting down a rain-soaked street at dusk.\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/kling/kling-v3-omni/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 取得します。モデル本来の出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/kling/kling-v3-omni/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**aspect\_ratio** `string`

生成されるビデオフレームのアスペクト比（幅:高さ）。先頭フレーム参照またはビデオ編集機能を使用しない場合に必須です。

取り得る値: `16:9`, `9:16`, `1:1`

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

このタスクの結果を受け取るコールバック通知先アドレス。設定すると、タスクのステータスが変化した際にサーバーが能動的に通知します。無視されます: comfy-api は転送前にこのフィールドを破棄します。Comfy Router がユーザーの代わりにポーリングします。

フォーマット: `uri`

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

ビデオの長さ（秒）。ビデオ編集機能（refer\_type: base）を使用する場合、出力の再生時間は入力ビデオと同じになり、このパラメータは無効です。

取り得る値: `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15`

**element\_list** `object[]`

エレメントIDの設定に基づく参照エレメントリスト。

**element\_list\[].element\_id** `integer` *required*

エレメントID

フォーマット: `int64`

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

カスタムタスクID。単一のユーザーアカウント内で一意である必要があります。無視されます: comfy-api は転送前にこのフィールドを破棄します。Comfy Router がユーザーの代わりにポーリングします。

**image\_list** `object[]`

参照画像リスト。エレメント、シーン、スタイルなどの参照画像を含めることができ、また先頭または最後のフレームとしてビデオを生成するために使用できます。

**image\_list\[].image\_url** `string`

画像のBase64エンコードまたは画像URL（アクセス可能であることを確認してください）。サポートされるフォーマットには .jpg/.jpeg/.png が含まれます。ファイルサイズは10MBを超えることはできません。幅と高さの寸法は300px以上、アスペクト比は1:2.5～2.5:1の範囲である必要があります。

**image\_list\[].type** `string`

画像が先頭フレームか最後のフレームかを示します。first\_frame は先頭フレーム、end\_frame は最後のフレームです。現在、最後のフレームのみはサポートされていません。

取り得る値: `first_frame`, `end_frame`

**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 パラメータは無効です。

**prompt** `string`

テキストプロンプトワード。ポジティブおよびネガティブな記述を含めることができます。2,500文字を超えてはなりません。\<\<\<>>> の形式でエレメント、画像、ビデオを指定できます。例: \<\<element\_1>>、\<\<\<image\_1>>>、\<\<\<video\_1>>>。

**shot\_type** `string`

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

取り得る値: `customize`, `intelligence`

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

ビデオ生成時に同時にサウンドを生成するかどうか。

取り得る値: `on`, `off`

**video\_list** `object[]`

参照ビデオリスト。フィーチャーの参照ビデオとして、または編集対象のビデオとして使用できます。デフォルトでは編集対象のビデオです。

**video\_list\[].keep\_original\_sound** `string`

ビデオのオリジナルサウンドを保持するかどうか。yes は保持、no は保持しないことを示します。

取り得る値: `yes`, `no`

**video\_list\[].refer\_type** `string`

参照ビデオタイプ。feature はフィーチャー参照ビデオ、base は編集対象のビデオです。

取り得る値: `feature`, `base`

**video\_list\[].video\_url** `string` *required*

アップロードされたビデオのURL。.mp4/.mov フォーマットのみサポートされます。再生時間は3～10秒。解像度は720px～2160pxである必要があります。24～60 fpsのフレームレートをサポートします。アップロードできるビデオは1つだけで、サイズは200MBを超えてはなりません。

**watermark\_info** `object`

ウォーターマーク付きの結果を同時に生成するかどうか。現時点ではカスタムウォーターマークはサポートされていません。

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

true はウォーターマークを生成、false は生成しないことを意味します。

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

ビデオ生成モード。std: スタンダードモード、720Pビデオを生成、コスト効率が良い。pro: プロフェッショナルモード、1080Pビデオを生成、より高品質なビデオ出力。4k: ウルトラHDモード、4K解像度のビデオを生成。4k をサポートするのは kling-v3-omni のみです。kling-video-o1 は pro/std のみに対応します。

取り得る値: `pro`, `std`, `4k`

Routerが `GET /v2/models/kling/kling-v3-omni/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": "pro",
  "prompt": "A paper boat drifting down a rain-soaked street at dusk."
}
```

### 出力

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