pika/pika-soundtrack の API リファレンスです。Comfy Router が Pika から提供します。
入力: ビデオ、テキスト · 出力: ビデオ + オーディオ
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用しています。cURL のスニペットは同じ呼び出しを生の HTTP で行うものです。
モデル ID: pika/pika-soundtrack
エンドポイント: POST https://api.comfy.org/v2/models/pika/pika-soundtrack
- 結果を待つ
- キューに送信して後で収集する
同じボディを
POST https://api.comfy.org/v2/models/pika/pika-soundtrack/requests に送信します。Router は実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも収集できます。キュー配信では、ステータス、キャンセル、収集の流れを順に説明します。スキーマ
入力
string
オーディオがどうあるべきか、そしてアクションにどう追従するか。ビデオのみからサウンドデザインを行う場合は省略します。
integer
デフォルト:"-1"
-1 から 2147483647 までのシード。-1 を指定するとランダムなシードが選ばれます。範囲:
-1 から 2147483647string
必須
ソースビデオの URL。H.264 または HEVC、最大 1200 秒、2 GB まで。
GET /v2/models/pika/pika-soundtrack/openapi.json で提供するスキーマから生成されており、リクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントです。
出力
object
failed ジョブの場合に設定されます。string
機械可読な失敗コード。invalid_input、content_moderation、provider_error など。
string
診断用テキスト。
string
ステータスのポーリングに使用するジョブID。
string
ジョブが実行した Pika カタログエントリ。
object
完了したジョブのメディア。
status が completed の場合に設定されます。object
生成済みメディアファイル 1 件。
string
ファイルの MIME タイプ。
string
生成済みファイルのダウンロード URL。
string
ファイルを格納するフィールド: video または audio。
object
生成済みメディアファイル 1 件。
string
ファイルの MIME タイプ。
string
生成済みファイルのダウンロード URL。
string
ジョブのステータス: queued、running、completed、failed。
object
Pika がジョブについて報告したユニット数。
例
入力
出力
出荷前の確認
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 が現在対応していないことと、代替手段。