kling/kling-v3 の API リファレンス。Kling から提供され、Comfy Router 経由で配信されます。
クイックスタート
Comfy ワークスペース でキーを作成し、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
- Wait for the result
- Queue and collect later
スキーマ
入力
string
デフォルト:"\"16:9\""
ビデオのアスペクト比指定可能な値:
16:9, 9:16, 1:1string (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, 15string
カスタムタスクID
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
ネガティブテキストプロンプト。ネガティブプロンプトの情報は、ポジティブプロンプト内に直接ネガティブな文を加えて補足することを推奨します。
string
ポジティブテキストプロンプト。voice_list パラメータの順序に対応する音声を指定するには、<<<voice_1>>> を使用します。1 つのタスクで参照できるトーンは最大 2 つです。トーンを指定する場合、sound パラメータの値は on である必要があります。
string
ストーリーボード方法。multi_shot パラメータが true に設定されている場合に必須です。指定可能な値:
customize, intelligencestring
デフォルト:"\"off\""
ビデオ生成時に同時にサウンドを生成するかどうか。このパラメータをサポートするのは V2.6 以降のモデルのみです。指定可能な値:
on, offobject
ウォーターマーク付きの結果を同時に生成するかどうか。現時点ではカスタムウォーターマークはサポートされていません。
boolean
true はウォーターマークを生成することを意味し、false は生成しないことを意味します。
GET /v2/models/kling/kling-v3/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する際に Router が使用するドキュメントと同じです。
出力
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 が現在対応していないことと、代替手段。