ComfyPilotComfyPilot
文档 / 开发 / 使用 Comfy Router 调用 Pika Soundtrack

使用 Comfy Router 调用 Pika Soundtrack

通过 Comfy Router 调用 pika/pika-soundtrack：端点、请求结构以及 Router 返回的响应。

开发 code 更新于 2026-11-04

查看官方原文

使用 Comfy Router 调用 Pika Soundtrack

通过 Comfy Router 调用 pika/pika-soundtrack：端点、请求结构以及 Router 返回的响应。

pika/pika-soundtrack 的 API 参考，由 Pika 通过 Comfy Router 提供。

输入： 视频、文本 · 输出： 视频 + 音频

快速开始

在 你的 Comfy 工作区 中创建密钥，并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK（pip install comfy-sdk 和 npm install @comfyorg/sdk）；cURL 代码片段则是通过原始 HTTP 发起的同一个调用。

模型 ID： pika/pika-soundtrack

端点： POST https://api.comfy.org/v2/models/pika/pika-soundtrack

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用该键。 with Comfy() as client: result = client.models.run( "pika/pika-soundtrack", { "seed": -1, "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用该键。 const { data } = await comfy.models.run("pika/pika-soundtrack", { seed: -1, video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/pika/pika-soundtrack \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" ``
[tab] 先入队，稍后收集 相同的请求体，发送到 POST https://api.comfy.org/v2/models/pika/pika-soundtrack/requests。运行一旦被接纳，Router 就会返回 201 和 request_id，结果就绪后即可从当前进程或其他进程收集。队列投递 介绍了状态、取消和收集的流程。 ``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-soundtrack", { "seed": -1, "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", }, ) 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-soundtrack", { seed: -1, video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", }); 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-soundtrack/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" # 2. 轮询直到状态为 COMPLETED，每次响应中给出的 Retry-After 秒数都需要等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时带有模型的原生输出，仍在运行时则返回 202 和状态响应体。 curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

instruction string

音频应该是什么，以及它如何跟随动作。若只想依据视频本身进行声音设计，可省略此项。

seed integer (default: -1)

种子，取值从 -1 到 2147483647。-1 表示随机选取一个种子。

范围：-1 到 2147483647

video string required

来源视频的 URL，H.264 或 HEVC 编码，最长 1200 秒，最大 2 GB。

本文档生成自 Router 在 GET /v2/models/pika/pika-soundtrack/openapi.json 提供的 schema，这也是它在请求到达提供商之前校验调用时所使用的同一份文档。

输出

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

任务状态：排队中、运行中、已完成或失败。

usage object

Pika 为该任务上报的单位数。

示例

输入

{
  "seed": -1,
  "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4"
}

输出

{
  "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0",
  "output": {
    "media_type": "video",
    "video": {
      "content_type": "video/mp4",
      "url": "https://example.invalid/pika/video.mp4"
    }
  },
  "status": "completed"
}

发布前须知

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。

[card] 请求头 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
[card] 使用 Router API 模型发现、验证错误、重试与计费。
[card] 限制 Router 目前不支持的功能，以及替代方案。