pika/pika-music の 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-music
エンドポイント: POST https://api.comfy.org/v2/models/pika/pika-music
- 結果を待つ
- キューに送信して後で収集する
同じボディを
POST https://api.comfy.org/v2/models/pika/pika-music/requests に送信します。Router は実行が受け付けられるとすぐに request_id とともに 201 を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集します。キュー配信では、ステータス、キャンセル、収集の流れを順を追って説明します。スキーマ
入力
boolean
デフォルト:"false"
使用前に参照オーディオをクリーンアップします。
number
デフォルト:"30"
音楽の長さ(秒)、10〜360。範囲:
10 〜 360string
歌唱する歌詞。
string
デフォルト:"\"text_to_music\""
生成モード: text_to_music、voice_conditioned_text_to_music、music_cover。指定可能な値:
text_to_music、voice_conditioned_text_to_music、music_coverstring
必須
音楽の説明。
string
音声参照の URL。
voice_consent_attested を true に設定する必要があります。boolean
デフォルト:"false"
生成前にモデルで短いプロンプトを展開します。
integer
デフォルト:"-1"
再現可能な出力のためのシード、-1〜2147483647。-1 を指定するとランダムなシードが選ばれます。範囲:
-1 〜 2147483647string
music_cover 用のソース曲の URL。boolean
デフォルト:"false"
reference_audio の音声をクローンする権利を呼び出し元が有していることを証明します。GET /v2/models/pika/pika-music/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 が現在対応していないことと、代替手段。