synclabs/sync-3 の API リファレンス。Synclabs から Comfy Router によって提供されています。
クイックスタート
Comfyワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。PythonとTypeScriptのスニペットはComfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用しています。cURLのスニペットは、同じ呼び出しを生のHTTPで行うものです。
モデルID: synclabs/sync-3
エンドポイント: POST https://api.comfy.org/v2/models/synclabs/sync-3
- 結果を待つ
- キューに送信して後で収集する
同じボディを
POST https://api.comfy.org/v2/models/synclabs/sync-3/requests に送信します。Routerは実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集できます。キューの配信では、ステータス、キャンセル、収集について説明します。スキーマ
入力
object
Sync Labs の生成リクエストに付加される吹き替えパラメータ
integer
ソースビデオ内の話者数。0 にすると自動検出が有効になります
string
必須
吹き替えに使用するプロバイダー(例: elevenlabs)
string
ソース言語コード。デフォルトは auto
string
必須
吹き替えのターゲット言語コード
object[]
必須
入力項目。視覚入力(ビデオまたは画像)を 1 つ、およびオーディオまたはテキスト入力を 1 つだけ指定します
string
Sync Labs メディアライブラリのアセット ID
object
Sync Labs のテキスト入力用のテキスト読み上げプロバイダー設定
string
必須
TTS プロバイダー名(例: elevenlabs)
string
必須
生成に使用するスクリプト
number
AI がオリジナルの音声にどれだけ忠実に従うかフォーマット:
doublenumber
音声の安定性。値を小さくすると感情の幅が広がりますフォーマット:
doublestring
必須
Sync のボイス ID(Studio でクローンした音声)または ElevenLabs のボイス ID
string
この入力をセグメント定義にリンクするために使用する参照識別子
integer[][]
非推奨。代わりにトップレベルの segments 配列を使用してください
number[][]
非推奨。代わりにトップレベルの segments 配列を使用してください
string
必須
入力タイプ(video、image、audio、または text)
string
生成に使用するメディアの URL
string
生成に使用するモデルの名前。サポートされるのは sync-3 のみです。Comfy Router のルート
POST /v2/models/synclabs/{model} では、このフィールドはパスから供給されるため省略できます。object
Sync Labs の生成で使用できる追加オプション
object
アクティブスピーカー検出の設定
boolean
アクティブスピーカーを自動的に検出し、生成を適用するかどうか
integer[][]
検出された顔のフレームごとのバウンディングボックス [x1, y1, x2, y2] の配列
string
バウンディングボックスを含む JSON ファイルへの URL
integer[]
frame_number で識別されるソースビデオフレーム内のピクセル座標 [x, y]
integer
手動の話者選択のために、指定された座標に対応するフレームインデックス
boolean
ASD v3 を使用するかどうか
string
モデルの編集領域(lips、face、head)。react-1 でのみ動作します
boolean
生成中にオクルージョンを検出するかどうか
string
感情プロンプト。react-1 でのみ動作します
string
ビデオとオーディオの再生時間の不一致を処理する方法(bounce、loop、cut_off、silence、remap)
number
リップシンクの表現力の度合い(0 ~ 1)フォーマット:
doublestring
生成された出力の拡張子を除いたベースファイル名
string
必要に応じて、この生成を Sync Labs プロジェクトに紐付けます
object[]
異なるビデオセグメントに異なるオーディオ入力を適用するセグメント定義
object
必須
特定のセグメントのオーディオ入力設定
number
参照されたオーディオを切り出すためのオプションの終了時間(秒)フォーマット:
doublestring
必須
このセグメントに使用するオーディオ/テキスト読み上げ入力の参照 ID
number
参照されたオーディオを切り出すためのオプションの開始時間(秒)フォーマット:
doublenumber
必須
セグメントの終了時間(秒)フォーマット:
doubleobject
特定のセグメントの生成オプションをオーバーライドします
object
アクティブスピーカー検出の設定
boolean
アクティブスピーカーを自動的に検出し、生成を適用するかどうか
integer[][]
検出された顔のフレームごとのバウンディングボックス配列 [x1, y1, x2, y2]
string
バウンディングボックスを含む JSON ファイルへの URL
integer[]
frame_number で識別されるソースビデオフレーム内のピクセル座標 [x, y]
integer
手動での話者選択のために、指定された座標に対応するフレームインデックス
boolean
ASD v3 を使用するかどうか
boolean
このセグメントのオクルージョン検出を上書きします
string
このセグメントの sync モードを上書きします
number
このセグメントの temperature (0-1) を上書きしますフォーマット:
doublenumber
必須
セグメントの開始時間(秒)フォーマット:
doublestring
生成ステータス更新用の Webhook URL
GET /v2/models/synclabs/sync-3/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。
出力
string
生成が作成された日時
string
生成に失敗した場合のエラーメッセージ
string
生成に失敗した場合の、安定した機械可読なエラーコード
string
生成の一意の識別子
object[]
生成に使用された入力項目
string
Sync Labs メディアライブラリのアセットの ID
object
Sync Labs のテキスト入力に対するテキスト読み上げプロバイダーの設定
string
必須
TTS プロバイダー名(例: elevenlabs)
string
必須
生成に使用するスクリプト
number
AI がオリジナルの音声にどれだけ忠実に従うか形式:
doublenumber
音声の安定性。値を下げると感情の幅が広がります形式:
doublestring
必須
Sync の音声 ID(Studio でクローンした音声)または ElevenLabs の音声 ID
string
この入力をセグメント定義にリンクするために使用される参照識別子
integer[][]
非推奨。代わりに最上位の segments 配列を使用してください
number[][]
非推奨。代わりに最上位の segments 配列を使用してください
string
必須
入力タイプ(video、image、audio、text)
string
生成に使用するメディアの URL
string
生成に使用されたモデルの名前
object
Sync Labs の生成で利用できる追加オプション
object
アクティブスピーカー検出の設定
boolean
アクティブスピーカーを自動的に検出して生成を適用するかどうか
integer[][]
検出された顔のフレームごとのバウンディングボックス [x1, y1, x2, y2] の配列
string
バウンディングボックスを含む JSON ファイルへの URL
integer[]
frame_number で識別されるソースビデオフレーム内のピクセル座標 [x, y]
integer
手動で話者を選択するために、指定された座標に対応するフレームインデックス
boolean
ASD v3 を使用するかどうか
string
モデルの編集領域(lips、face、head)。react-1 でのみ動作します
boolean
生成中にオクルージョンを検出するかどうか
string
感情プロンプト。react-1 でのみ動作します
string
ビデオとオーディオの再生時間の不一致を処理する方法(bounce、loop、cut_off、silence、remap)
number
リップシンクの表現力の度合い(0 から 1)形式:
doublenumber
出力メディアの再生時間(秒)形式:
doublestring
出力メディアに適用されるサニタイズされたファイル名
string
出力メディアの URL
string
この生成が紐づけられているプロジェクトの id
string
セグメント出力メディアの URL
object[]
生成のセグメント
object
必須
特定のセグメントのオーディオ入力設定
number
参照されたオーディオを切り取るためのオプションの終了時間(秒)形式:
doublestring
必須
このセグメントで使用するオーディオ/テキスト読み上げ入力の参照 ID
number
参照されたオーディオを切り取るためのオプションの開始時間(秒)形式:
doublenumber
必須
セグメントの終了時間(秒)形式:
doubleobject
特定のセグメントの生成オプションを上書きする
object
アクティブスピーカー検出の設定
boolean
アクティブスピーカーを自動的に検出して生成を適用するかどうか
integer[][]
検出された顔のフレームごとのバウンディングボックス配列 [x1, y1, x2, y2]
string
バウンディングボックスを含む JSON ファイルへの URL
integer[]
frame_number で識別されるソースビデオフレーム内のピクセル座標 [x, y]
integer
手動で話者を選択するために指定された座標に対応するフレームインデックス
boolean
ASD v3 を使用するかどうか
boolean
このセグメントのオクルージョン検出を上書きする
string
このセグメントの同期モードを上書きする
number
このセグメントの temperature(0〜1)を上書きする形式:
doublenumber
必須
セグメントの開始時間(秒)形式:
doublestring
生成のステータス(PENDING、PROCESSING、COMPLETED、FAILED、REJECTED)
string
テキスト(TTS)入力から合成されたオーディオの URL
string
webhook エンドポイントの URL
例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズ を参照してください。
このページは、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 を参照してください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。