pika/pika-2.5-text-to-video の API リファレンスです。Pika から Comfy Router によって提供されます。
入力: テキスト · 出力: ビデオ
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk と npm install @comfyorg/sdk)を使用しています。cURL のスニペットは同じ呼び出しを生の HTTP で行うものです。
モデル ID: pika/pika-2.5-text-to-video
エンドポイント: POST https://api.comfy.org/v2/models/pika/pika-2.5-text-to-video
- 結果を待つ
- キューに送信して後で収集する
同じボディを
POST https://api.comfy.org/v2/models/pika/pika-2.5-text-to-video/requests に送信します。Router は実行が受け付けられるとすぐに 201 と request_id を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも収集できます。キューの配信では、ステータス、キャンセル、収集について説明しています。スキーマ
入力
integer
デフォルト:"5"
ビデオの長さ(秒単位)。テキストから動画へは5秒のクリップのみを生成します。指定可能な値:
5string
ビデオで避けたい内容を記述したテキスト。
string
必須
生成するビデオを記述したテキストプロンプト。
string
デフォルト:"\"1080p\""
出力解像度。指定可能な値:
720p, 1080pinteger
再現可能な生成のためのシード。ランダムなシードにするには省略するか、null を送信します。
GET /v2/models/pika/pika-2.5-text-to-video/openapi.json で提供するスキーマから生成されています。これは、リクエストがプロバイダーに届く前に Router が呼び出しを検証する対象となるドキュメントと同じものです。
出力
object
Pika の構造化された失敗記録で、
failed のジョブに設定されます。Router は失敗したジョブに対して Router 自身のエラー応答を返すため、Router が返すボディにはこれが含まれません。Pika のジョブドキュメントの一部であるため宣言されています。string
必須
指定可能な値:
invalid_input, content_moderation, provider_error, provider_timeout, provider_unavailable, rate_limited, insufficient_balance, membership_required, cycle_limit_exceeded, admission_suspended, usage_limit_exceeded, timed_out, internalstring
必須
string
必須
Pika のジョブID。
string
ジョブが実行した Pika カタログのエントリ。
object
完了したジョブのメディアで、
status が completed のときに設定されます。media_type はどのフィールドがそれを保持するかを示します。image は images に、video は video に、videos は videos に格納されます。object[]
生成された画像。画像モデル用です。
string
ファイルの MIME タイプ。
integer
高さ(ピクセル単位)。
string
生成されたファイルのダウンロード URL。
integer
幅(ピクセル単位)。
string
指定可能な値:
image, video, videosinteger
ビデオジョブが実際に使用したシード(報告された場合)。
object
生成されたメディアファイル1つ。
string
ファイルの MIME タイプ。
integer
高さ(ピクセル単位)。
string
生成されたファイルのダウンロード URL。
integer
幅(ピクセル単位)。
object[]
生成されたビデオ。複数ビデオの配信向けです。
string
ファイルの MIME タイプ。
integer
高さ(ピクセル単位)。
string
生成されたファイルのダウンロード URL。
integer
幅(ピクセル単位)。
number
生成にかかった秒数(ディスパッチから終了まで)。ベストエフォートであり、null の場合があります。
string
必須
ライフサイクル状態。Router が返すボディは常に
completed と表示されます。failed のジョブは代わりに Router のエラー応答で返されます。指定可能な値: queued, running, completed, failedobject
ジョブについてプロバイダーが報告する単位。キーは疎で、ジョブが報告する単位のみが存在します。
例
入力
出力
出荷前の確認
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 が現在対応していないことと、代替手段。