kling/kling-v2-1 の API リファレンス。Comfy Router が Kling から提供しています。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用します。cURL スニペットは、生の HTTP 経由で同じ呼び出しを行います。
モデル ID: kling/kling-v2-1
エンドポイント: POST https://api.comfy.org/v2/models/kling/kling-v2-1
- Wait for the result
- Queue and collect later
スキーマ
入力
string (uri)
コールバック通知先のアドレス。タスクのステータスが変更されるとサーバーが通知します。形式:
uriobject
object
number
カメラの水平軸(x軸)に沿った動きを制御します。負の値は左、正の値は右を示します。範囲:
-10 から 10number
垂直面内でのカメラの回転(x軸)を制御します。負の値は下向きの回転、正の値は上向きの回転を示します。範囲:
-10 から 10number
カメラのロール量(z軸)を制御します。負の値は反時計回り、正の値は時計回りを示します。範囲:
-10 から 10number
水平面内でのカメラの回転(y軸)を制御します。負の値は左への回転、正の値は右への回転を示します。範囲:
-10 から 10number
カメラの垂直軸(y軸)に沿った動きを制御します。負の値は下、正の値は上を示します。範囲:
-10 から 10number
カメラの焦点距離の変化を制御します。負の値は画角が狭くなること、正の値は画角が広くなることを示します。範囲:
-10 から 10string
定義済みのカメラムーブメントタイプ。simple: カスタマイズ可能なカメラムーブメント。down_back: カメラが下降しながら後退します。forward_up: カメラが前進しながら上を向きます。right_turn_forward: 右に回転して前進します。left_turn_forward: 左に回転して前進します。指定可能な値:
simple, down_back, forward_up, right_turn_forward, left_turn_forwardnumber
デフォルト:"0.5"
ビデオ生成における柔軟性。値が高いほどモデルの柔軟性が低くなり、ユーザーのプロンプトとの関連性が強くなります。範囲:
0 から 1形式: floatstring
デフォルト:"\"5\""
ビデオの長さ(秒)指定可能な値:
3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15object[]
動的ブラシ設定リスト(最大6グループ)。5秒のビデオの場合、軌跡の長さは77座標を超えてはなりません。
string (uri)
動的ブラシの適用領域(ユーザーがモーションブラシを使用して作成したマスク画像)。アスペクト比は入力画像と一致している必要があります。形式:
uriobject[]
integer
軌跡ポイントの水平座標。画像の左下隅を原点(0,0)とします。
integer
軌跡ポイントの垂直座標。画像の左下隅を原点(0,0)とします。
object[]
エレメントID設定に基づく参照エレメントリスト。最大3つの参照エレメントをサポートします。element_list パラメータと voice_list パラメータは同時に使用できません。
integer
必須
エレメントID形式:
int64string
カスタマイズしたタスクID。単一のユーザーアカウント内で一意である必要があります。
string
参照画像: URL または Base64 エンコード文字列。10MB を超えることはできず、解像度は 300*300px 以上、アスペクト比は 1:2.5 ~ 2.5:1 の範囲である必要があります。Base64 には data:image プレフィックスを含めないでください。
string
参照画像: 終了フレーム制御。URL または Base64 エンコード文字列。10MB を超えることはできず、解像度は 300*300px 以上である必要があります。Base64 には data:image プレフィックスを含めないでください。dynamic_masks/static_mask または camera_control と同時に使用することはできません。
string
デフォルト:"\"std\""
ビデオ生成モード。std: スタンダードモード。コスト効率に優れています。pro: プロフェッショナルモード。より長い再生時間のビデオを生成しますが、出力品質が高くなります。指定可能な値:
std, prostring
モデル名。Comfy Router を使用する場合は省略するか null を送信してください。モデルはリクエストパスによって選択されます。名前を指定する場合は、そのパスと一致している必要があります。
object[]
各ストーリーボードに関する情報(プロンプトや再生時間など)。最大6つのストーリーボードをサポートし、最低1つ必要です。multi_shot が true で shot_type が customize の場合に必須です。
string
このストーリーボードの再生時間(秒)。タスクの合計再生時間を超えてはならず、1未満であってもなりません。すべてのストーリーボードの再生時間の合計がタスクの合計再生時間と等しくなります。
integer
ショットの連番
string
このストーリーボードのプロンプトワード。最大長512文字。
boolean
デフォルト:"false"
マルチショットビデオを生成するかどうか。true の場合、prompt パラメータは無効です。false の場合、shot_type パラメータと multi_prompt パラメータは無効です。
string
Negative text prompt. It is recommended to supplement negative prompt information through negative sentences directly within positive prompts.
string
ポジティブテキストプロンプト。<voice_1>> を使用して、voice_list パラメータの順序に対応する音声を指定します。1つのタスクで最大2つのトーンを参照できます。トーンを指定する場合、sound パラメータの値は on である必要があります。
string
絵コンテ方式。multi_shot パラメータが true に設定されている場合に必須です。取り得る値:
customize、intelligencestring
デフォルト:"\"off\""
動画生成時に同時にサウンドを生成するかどうか。このパラメータをサポートするのは V2.6 以降のバージョンのモデルのみです。取り得る値:
on、offstring
静的ブラシ適用領域(ユーザーがモーションブラシを使用して作成するマスク画像)。アスペクト比は入力画像と一致する必要があります。
object[]
動画生成時に参照する音声のリスト。最大2つの音声をサポートします。element_list パラメータと voice_list パラメータは相互に排他的です。
string
必須
音声カスタマイズ API を通じて返される音声 ID、またはシステムプリセットの音声 ID。
object
ウォーターマーク付きの結果を同時に生成するかどうか。現時点ではカスタムウォーターマークはサポートされていません。
boolean
true はウォーターマークを生成する、false は生成しないことを意味します。
GET /v2/models/kling/kling-v2-1/openapi.json でこのスキーマを提供しており、リクエストがプロバイダーに到達する前に、呼び出しを検証する際に使用するドキュメントと同じものです。
出力
integer
エラーコード
object
integer
タスク作成時間、Unix タイムスタンプ(ミリ秒)
string
タスクの控除ユニット数
string
タスク ID
object
string
object
object[]
string
ビデオの合計再生時間(秒)
string
生成済みビデオ ID
string (uri)
生成済みビデオの URLフォーマット:
uristring (uri)
ウォーターマーク付きの生成済みビデオの URL、直リンク保護フォーマットフォーマット:
uristring
タスクステータス指定可能な値:
submitted、processing、succeed、failedstring
タスクステータス情報。タスクが失敗した場合は失敗理由を表示します
integer
タスク更新時間、Unix タイムスタンプ(ミリ秒)
object
boolean
string
エラーメッセージ
string
リクエスト ID
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。