跳转到主要内容
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 就会返回 201 和 request_id;结果准备就绪后即可收集,可以在本进程中收集,也可以在另一个进程中收集。队列交付 详细介绍了状态、取消和结果收集。

Schema

输入

boolean
默认值:"false"
使用前清理参考音频。
number
默认值:"30"
音乐时长,以秒为单位,10 到 360。范围:10 到 360
string
要演唱的歌词。
string
默认值:"\"text_to_music\""
生成模式:text_to_music、voice_conditioned_text_to_music 或 music_cover。可选值:text_to_music、voice_conditioned_text_to_music、music_cover
string
必填
音乐的描述。
string
声音参考的 URL。需要将 voice_consent_attested 设为 true。
boolean
默认值:"false"
生成前用模型展开简短的提示词。
integer
默认值:"-1"
用于可复现输出的种子,-1 到 2147483647。-1 表示随机选取种子。范围:-1 到 2147483647
string
music_cover 的源歌曲 URL。
声明调用方拥有克隆 reference_audio 中声音的权利。
根据 Router 在 GET /v2/models/pika/pika-music/openapi.json 提供的 schema 生成,Router 在请求到达提供商之前校验调用时所用的正是这份文档。

输出

object
在 failed 任务上设置。
string
机器可读的失败代码,例如 invalid_input、content_moderation 或 provider_error。
string
诊断文本。
string
用于轮询状态的任务ID。
string
该任务运行的 Pika 目录条目。
object
已完成任务的媒体,当 status 为 completed 时设置。
object
一个已生成的媒体文件。
string
文件的 MIME 类型。
string
已生成文件的下载 URL。
string
哪个字段承载文件:video 或 audio。
object
一个已生成的媒体文件。
string
文件的 MIME 类型。
string
已生成文件的下载 URL。
string
任务状态:queued、running、completed 或 failed。
object
Pika 为该任务上报的用量单位。

示例

输入

输出

发布前须知

SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。 请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。 上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。 本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端,用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图:Comfy(api_key=...) / new Comfy({ apiKey }),并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。

请求头

身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

使用 Router API

模型发现、验证错误、重试与计费。

限制

Router 目前不支持的功能,以及替代方案。