kling/kling-v1-5 の 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-v1-5
エンドポイント: POST https://api.comfy.org/v2/models/kling/kling-v1-5
- 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
Positive text prompt. Use <<<voice_1>>> to specify a voice matching the voice_list parameter order. A task can reference up to 2 tones. When specifying a tone, the sound parameter value must be on.
string
Storyboard method. Required when the multi_shot parameter is set to true.Possible values:
customize, intelligencestring
デフォルト:"\"off\""
Whether to generate sound simultaneously when generating videos. Only V2.6 and subsequent versions of the model support this parameter.Possible values:
on, offstring
Static Brush Application Area (Mask image created by users using the motion brush). The aspect ratio must match the input image.
object[]
List of voices referenced when generating videos. Supports up to 2 voices. The element_list and voice_list parameters are mutually exclusive.
string
必須
Voice ID returned through the voice customization API or a system preset voice ID.
object
Whether to generate watermarked results simultaneously. Custom watermark is not supported at this time.
boolean
true means generate watermark, false means do not generate.
GET /v2/models/kling/kling-v1-5/openapi.json, the same document it validates a call against before the request reaches the provider.
出力
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 が現在対応していないことと、代替手段。