> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Usar Pika Music con Comfy Router

> Llama a pika/pika-music con Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve el Router.

Referencia de API de `pika/pika-music`, servida por Comfy Router desde Pika.

**Entrada:** Texto, Audio · **Salida:** Audio

## Inicio rápido

Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada sobre HTTP sin procesar.

**ID del modelo:** `pika/pika-music`

**Endpoint:** `POST https://api.comfy.org/v2/models/pika/pika-music`

> [tab] Esperar el resultado
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # Lee COMFY_API_KEY del entorno.
> # El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos.
> with Comfy() as client:
>     result = client.models.run(
>         "pika/pika-music",
>         {
>             "duration": 30,
>             "mode": "text_to_music",
>             "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // Lee COMFY_API_KEY del entorno.
> // El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos.
> const { data } = await comfy.models.run("pika/pika-music", {
>   duration: 30,
>   mode: "text_to_music",
>   prompt: "warm lo-fi hip hop with soft piano and vinyl crackle",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/pika/pika-music \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}"
> ```

> [tab] Encolar y recopilar más tarde
>
> El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/pika/pika-music/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recopila cuando está listo, desde este proceso o desde otro. [Entrega en cola](https://docs.comfy.org/es/development/comfy-router/queue.md) recorre el estado, la cancelación y la recopilación.
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # Lee COMFY_API_KEY del entorno.
> # Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos.
> async def main():
>     async with AsyncComfy() as client:
>         handle = await client.models.submit(
>             "pika/pika-music",
>             {
>                 "duration": 30,
>                 "mode": "text_to_music",
>                 "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle",
>             },
>         )
>         print("request_id:", handle.request_id)  # junto con el ID del modelo, es todo lo que otro proceso necesita
>
>         # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor.
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # La carga propia del proveedor, el mismo valor que devuelve models.run().
>         # Una solicitud que falló o se canceló genera aquí el error tipado de Router.
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // Lee COMFY_API_KEY del entorno.
> // Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos.
> const handle = await comfy.models.submit("pika/pika-music", {
>   duration: 30,
>   mode: "text_to_music",
>   prompt: "warm lo-fi hip hop with soft piano and vinyl crackle",
> });
> console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que otro proceso necesita
>
> // Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor.
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí.
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url.
> curl https://api.comfy.org/v2/models/pika/pika-music/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}"
>
> # 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta.
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. Recopila. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución.
> curl https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## Esquema

### Entrada

**clean\_reference\_audio** `boolean` (default: false)

Limpia el audio de referencia antes de usarlo.

**duration** `number` (default: 30)

Duración de la música en segundos, de 10 a 360.

Rango: `10` a `360`

**lyrics** `string`

Letra para cantar.

**mode** `string` (default: "text\_to\_music")

Modo de generación: text\_to\_music, voice\_conditioned\_text\_to\_music o music\_cover.

Valores posibles: `text_to_music`, `voice_conditioned_text_to_music`, `music_cover`

**prompt** `string` *required*

Descripción de la música.

**reference\_audio** `string`

URL de una referencia de voz. Requiere que `voice_consent_attested` esté establecido en true.

**rewrite\_prompt** `boolean` (default: false)

Expande un prompt corto con un modelo antes de la generación.

**seed** `integer` (default: -1)

Semilla para una salida reproducible, de -1 a 2147483647. -1 elige una semilla aleatoria.

Rango: `-1` a `2147483647`

**source\_audio** `string`

URL de la canción fuente para `music_cover`.

**voice\_consent\_attested** `boolean` (default: false)

Confirma que quien llama tiene los derechos para clonar la voz en `reference_audio`.

Generado a partir del esquema que Router sirve en `GET /v2/models/pika/pika-music/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor.

### Salida

**error** `object`

Se establece en una tarea `failed`.

**error.code** `string`

Código de fallo legible por máquina, como invalid\_input, content\_moderation o provider\_error.

**error.message** `string`

Texto de diagnóstico.

**id** `string`

ID de trabajo usado para consultar el estado.

**model\_id** `string`

La entrada del catálogo de Pika que ejecutó la tarea.

**output** `object`

Los archivos multimedia de la tarea finalizada, establecidos cuando `status` es `completed`.

**output.audio** `object`

Un archivo multimedia generado.

**output.audio.content\_type** `string`

Tipo MIME del archivo.

**output.audio.url** `string`

URL de descarga del archivo generado.

**output.media\_type** `string`

Qué campo contiene el archivo: video o audio.

**output.video** `object`

Un archivo multimedia generado.

**output.video.content\_type** `string`

Tipo MIME del archivo.

**output.video.url** `string`

URL de descarga del archivo generado.

**status** `string`

Estado de la tarea: queued, running, completed o failed.

**usage** `object`

Unidades que Pika reportó para la tarea.

## Ejemplos

### Entrada

```json theme={null}
{
  "duration": 30,
  "mode": "text_to_music",
  "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle"
}
```

### Salida

```json theme={null}
{
  "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44",
  "output": {
    "audio": {
      "content_type": "audio/mpeg",
      "url": "https://example.invalid/pika/audio.mp3"
    },
    "media_type": "audio"
  },
  "status": "completed"
}
```

## Antes de lanzar

Los SDK crean una `Idempotency-Key` y la reutilizan para los reintentos automáticos. Para los reintentos manuales, reutiliza la clave original. Router puede mantener la conexión abierta hasta 10 minutos.

Cuando una solicitud falla, Router envía un encabezado de respuesta `X-Comfy-Error-Type` que explica el motivo. Un `422` significa que Router rechazó la entrada antes de llamar al proveedor, y un `413` significa que el cuerpo de la solicitud era más grande de lo que Router acepta. Descarga los recursos generados de inmediato, porque [las URL de resultados pueden caducar](https://docs.comfy.org/es/development/comfy-router/reference.md#recursos-del-resultado).

Cualquier límite de tamaño mencionado en la descripción de un campo más arriba es el límite propio del proveedor para ese campo, citado de la especificación del proveedor. Router aplica un tope aparte al cuerpo completo de la solicitud, con el que cuentan los medios codificados en base64: consulta [tamaño del cuerpo de la solicitud](https://docs.comfy.org/es/development/comfy-router/limitations.md#los-cuerpos-de-las-solicitudes-tienen-un-límite).

Esta página documenta un modelo socio al que se llama a través de Comfy Router. El mismo paquete `comfy-sdk` / `@comfyorg/sdk` también incluye un segundo cliente, para ejecutar todo un gráfico de flujo de trabajo de ComfyUI en Comfy Cloud: `Comfy(api_key=...)` / `new Comfy({ apiKey })`, con `client.workflows`, `client.assets` y `client.jobs`. Consulta [SDK de Comfy](https://docs.comfy.org/es/development/api-development/sdks.md).

> [card] [Encabezados](https://docs.comfy.org/es/development/comfy-router/headers.md)
>
> Autenticación, idempotencia, IDs de solicitud, agrupaciones de errores, ritmo de reintentos y límites de gasto.

> [card] [Uso de la API de Router](https://docs.comfy.org/es/development/comfy-router/api.md)
>
> Descubrimiento de modelos, errores de validación, reintentos y facturación.

> [card] [Limitaciones](https://docs.comfy.org/es/development/comfy-router/limitations.md)
>
> Lo que Router no hace hoy y qué usar en su lugar.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.