Skip to main content
API Reference for pika/pika-music, served by Comfy Router from Pika. Input: Text, Audio · Output: Audio

Quick start

Create a key in your Comfy workspace and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk and npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP. Model ID: pika/pika-music Endpoint: POST https://api.comfy.org/v2/models/pika/pika-music
The same body, sent to POST https://api.comfy.org/v2/models/pika/pika-music/requests. Router answers 201 with a request_id as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. Queued delivery walks through status, cancellation and collection.

Schema

Input

boolean
default:"false"
Clean the reference audio before use.
number
default:"30"
Length of the music in seconds, 10 to 360.Range: 10 to 360
string
Lyrics to sing.
string
default:"\"text_to_music\""
Generation mode: text_to_music, voice_conditioned_text_to_music or music_cover.Possible values: text_to_music, voice_conditioned_text_to_music, music_cover
string
required
Description of the music.
string
URL of a voice reference. It needs voice_consent_attested set to true.
boolean
default:"false"
Expand a short prompt with a model before generation.
integer
default:"-1"
Seed for reproducible output, -1 to 2147483647. -1 picks a random seed.Range: -1 to 2147483647
string
URL of the source song for music_cover.
Attests that the caller has the rights to clone the voice in reference_audio.
Generated from the schema Router serves at GET /v2/models/pika/pika-music/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

object
Set on a failed job.
string
Machine-readable failure code, such as invalid_input, content_moderation or provider_error.
string
Diagnostic text.
string
Job id used to poll for status.
string
The Pika catalog entry the job ran.
object
The finished job’s media, set when status is completed.
object
One generated media file.
string
MIME type of the file.
string
Download URL of the generated file.
string
Which field carries the file: video or audio.
object
One generated media file.
string
MIME type of the file.
string
Download URL of the generated file.
string
Job status: queued, running, completed or failed.
object
Units Pika reported for the job.

Examples

Input

Output

Before you ship

The SDKs create an Idempotency-Key and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes. When a request fails, Router sends an X-Comfy-Error-Type response header explaining why. A 422 means Router rejected the input before calling the provider, and a 413 means the request body was larger than Router accepts. Download generated assets promptly because result URLs can expire. Any size limit named in a field description above is the provider’s own bound on that field, quoted from the provider’s specification. Router applies a separate cap to the whole request body, which base64-encoded media counts against: see request body size. This page documents one partner model called through Comfy Router. The same comfy-sdk / @comfyorg/sdk package also ships a second client, for running a whole ComfyUI workflow graph on Comfy Cloud: Comfy(api_key=...) / new Comfy({ apiKey }), with client.workflows, client.assets and client.jobs. See Comfy SDKs.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.