ComfyPilotComfyPilot
文档 / 开发 / 通过 Comfy Router 使用 Pika Sfx

通过 Comfy Router 使用 Pika Sfx

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

开发 code 更新于 2026-11-04

查看官方原文

通过 Comfy Router 使用 Pika Sfx

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

pika/pika-sfx 的 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-sfx

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

[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键，并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "pika/pika-sfx", { "duration": 2, "prompt": "a wooden door creaking open", }, ) print(result) ` `typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键，并在自动重试时复用它。 const { data } = await comfy.models.run("pika/pika-sfx", { duration: 2, prompt: "a wooden door creaking open", }); console.log(data); ` `bash cURL theme={null} curl https://api.comfy.org/v2/models/pika/pika-sfx \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" ``
[tab] 排队并稍后收集 相同的请求体，发送到 POST https://api.comfy.org/v2/models/pika/pika-sfx/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-sfx", { "duration": 2, "prompt": "a wooden door creaking open", }, ) 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-sfx", { duration: 2, prompt: "a wooden door creaking open", }); 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-sfx/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" # 2. 轮询直到状态为 COMPLETED，每次响应指定的 Retry-After 秒数都要等待。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集结果。已完成时返回 200 和模型的原始输出，仍在运行时返回 202 和状态正文。 curl https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``

Schema

输入

duration number (default: 10)

声音效果的时长，单位为秒，范围为 1 到 20。

范围：1 到 20

prompt string required

声音效果的描述。

seed integer (default: -1)

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

范围：-1 到 2147483647

根据 Router 在 GET /v2/models/pika/pika-sfx/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

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

usage object

Pika 针对该任务报告的用量单位。

示例

输入

{
  "duration": 2,
  "prompt": "a wooden door creaking open"
}

输出

{
  "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 会过期。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。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 目前不支持的功能，以及替代方案。