kling/kling-v3-omni の API リファレンス。
クイックスタート
Comfy ワークスペースでキーを作成し、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
- Wait for the result
- Queue and collect later
スキーマ
入力
string
生成されるビデオフレームのアスペクト比(幅:高さ)。先頭フレーム参照またはビデオ編集機能を使用しない場合に必須です。取り得る値:
16:9, 9:16, 1:1string (uri)
このタスクの結果を受け取るコールバック通知先アドレス。設定すると、タスクのステータスが変化した際にサーバーが能動的に通知します。フォーマット:
uristring
デフォルト:"\"5\""
ビデオの長さ(秒)。ビデオ編集機能(refer_type: base)を使用する場合、出力の再生時間は入力ビデオと同じになり、このパラメータは無効です。取り得る値:
3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15object[]
エレメントIDの設定に基づく参照エレメントリスト。
integer
必須
エレメントIDフォーマット:
int64string
カスタムタスクID。単一のユーザーアカウント内で一意である必要があります。
object[]
参照画像リスト。エレメント、シーン、スタイルなどの参照画像を含めることができ、また先頭または最後のフレームとしてビデオを生成するために使用できます。
string
画像のBase64エンコードまたは画像URL(アクセス可能であることを確認してください)。サポートされるフォーマットには .jpg/.jpeg/.png が含まれます。ファイルサイズは10MBを超えることはできません。幅と高さの寸法は300px以上、アスペクト比は1:2.5~2.5:1の範囲である必要があります。
string
画像が先頭フレームか最後のフレームかを示します。first_frame は先頭フレーム、end_frame は最後のフレームです。現在、最後のフレームのみはサポートされていません。取り得る値:
first_frame, end_framestring
デフォルト:"\"pro\""
ビデオ生成モード。std: スタンダードモード、720Pビデオを生成、コスト効率が良い。pro: プロフェッショナルモード、1080Pビデオを生成、より高品質なビデオ出力。取り得る値:
pro, stdstring
モデル名。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
テキストプロンプトワード。ポジティブおよびネガティブな記述を含めることができます。2,500文字を超えてはなりません。<<<>>> の形式でエレメント、画像、ビデオを指定できます。例: <<element_1>>、<<<image_1>>>、<<<video_1>>>。
string
ストーリーボード方法。multi_shot パラメータが true に設定されている場合に必須です。取り得る値:
customize, intelligencestring
デフォルト:"\"off\""
ビデオ生成時に同時にサウンドを生成するかどうか。取り得る値:
on, offobject[]
参照ビデオリスト。特徴の参照ビデオとして、または編集対象のビデオとして使用できます。デフォルトでは編集対象のビデオです。
string
ビデオのオリジナルサウンドを保持するかどうか。yes は保持、no は保持しないことを示します。取り得る値:
yes, nostring
参照ビデオタイプ。feature は特徴参照ビデオ、base は編集対象のビデオです。取り得る値:
feature, basestring
必須
アップロードされたビデオのURL。.mp4/.mov フォーマットのみサポートされます。再生時間は3~10秒。解像度は720px~2160pxである必要があります。24~60 fpsのフレームレートをサポートします。アップロードできるビデオは1つだけで、サイズは200MBを超えてはなりません。
object
ウォーターマーク付きの結果を同時に生成するかどうか。現時点ではカスタムウォーターマークはサポートされていません。
boolean
true はウォーターマークを生成、false は生成しないことを意味します。
GET /v2/models/kling/kling-v3-omni/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 が現在対応していないことと、代替手段。