> ## 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.

# 通过 Comfy Router 使用 Pika Music

> 通过 Comfy Router 调用 pika/pika-music：端点、请求形状以及 Router 返回的响应。

`pika/pika-music` 的 API 参考，由 Comfy Router 从 Pika 提供。

**输入：** 文本、音频 · **输出：** 音频

## 快速开始

在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥，并将其导出为 `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`

> [tab] 等待结果
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 从环境变量读取 COMFY_API_KEY。
> # SDK 会自动创建幂等键，并在自动重试时复用它。
> 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";
>
> // 从环境变量读取 COMFY_API_KEY。
> // SDK 会自动创建幂等键，并在自动重试时复用它。
> 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] 入队并稍后收集
>
> 相同的请求体，发送到 `POST https://api.comfy.org/v2/models/pika/pika-music/requests`。运行一旦被接纳，Router 就会返回 `201` 和 `request_id`；结果准备就绪后即可收集，可以在本进程中收集，也可以在另一个进程中收集。[队列交付](https://docs.comfy.org/zh/development/comfy-router/queue.md) 详细介绍了状态、取消和结果收集。
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 从环境变量读取 COMFY_API_KEY。
> # 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
> 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)  # 配合模型 ID，就是另一个进程所需的全部信息
>
>         # 轮询直到请求完成，每次按服务器给出的 Retry-After 等待。
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # 提供商自身的负载，与 models.run() 返回的值相同。
>         # 失败或已取消的请求会在此处抛出带类型的 Router 错误。
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 从环境变量读取 COMFY_API_KEY。
> // 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用它。
> 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); // 配合模型 ID，就是另一个进程所需的全部信息
>
> // 轮询直到请求完成，每次按服务器给出的 Retry-After 等待。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // 与 models.run() 返回的结果相同。失败或已取消的请求会在此处被拒绝。
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. 提交。Router 返回 201，并带有 request_id、status_url、response_url 和 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. 轮询直到状态为 COMPLETED，每次按响应中给出的 Retry-After 秒数等待。
> 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. 收集。200 返回模型的原始输出；仍在运行时则返回 202 和状态正文。
> curl https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## Schema

### 输入

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

使用前清理参考音频。

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

音乐时长，以秒为单位，10 到 360。

范围：`10` 到 `360`

**lyrics** `string`

要演唱的歌词。

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

生成模式：text\_to\_music、voice\_conditioned\_text\_to\_music 或 music\_cover。

可选值：`text_to_music`、`voice_conditioned_text_to_music`、`music_cover`

**prompt** `string` *required*

音乐的描述。

**reference\_audio** `string`

声音参考的 URL。需要将 `voice_consent_attested` 设为 true。

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

生成前用模型展开简短的提示词。

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

用于可复现输出的种子，-1 到 2147483647。-1 表示随机选取种子。

范围：`-1` 到 `2147483647`

**source\_audio** `string`

`music_cover` 的源歌曲 URL。

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

声明调用方拥有克隆 `reference_audio` 中声音的权利。

根据 Router 在 `GET /v2/models/pika/pika-music/openapi.json` 提供的 schema 生成，Router 在请求到达提供商之前校验调用时所用的正是这份文档。

### 输出

**error** `object`

在 `failed` 任务上设置。

**error.code** `string`

机器可读的失败代码，例如 invalid\_input、content\_moderation 或 provider\_error。

**error.message** `string`

诊断文本。

**id** `string`

用于轮询状态的任务ID。

**model\_id** `string`

该任务运行的 Pika 目录条目。

**output** `object`

已完成任务的媒体，当 `status` 为 `completed` 时设置。

**output.audio** `object`

一个已生成的媒体文件。

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

文件的 MIME 类型。

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

已生成文件的下载 URL。

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

哪个字段承载文件：video 或 audio。

**output.video** `object`

一个已生成的媒体文件。

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

文件的 MIME 类型。

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

已生成文件的下载 URL。

**status** `string`

任务状态：queued、running、completed 或 failed。

**usage** `object`

Pika 为该任务上报的用量单位。

## 示例

### 输入

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

### 输出

```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"
}
```

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](https://docs.comfy.org/zh/development/comfy-router/reference.md#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](https://docs.comfy.org/zh/development/comfy-router/limitations.md)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](https://docs.comfy.org/zh/development/api-development/sdks.md)。

> [card] [请求头](https://docs.comfy.org/zh/development/comfy-router/headers.md)
>
> 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

> [card] [使用 Router API](https://docs.comfy.org/zh/development/comfy-router/api.md)
>
> 模型发现、验证错误、重试与计费。

> [card] [限制](https://docs.comfy.org/zh/development/comfy-router/limitations.md)
>
> Router 目前不支持的功能，以及替代方案。


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