将 Eleven Sfx V2 与 Comfy Router 配合使用
通过 Comfy Router 调用 elevenlabs/eleven_sfx_v2:endpoint、请求结构以及 Router 返回的响应。
将 Eleven Sfx V2 与 Comfy Router 配合使用
通过 Comfy Router 调用 elevenlabs/eleven_sfx_v2:endpoint、请求结构以及 Router 返回的响应。
elevenlabs/eleven_sfx_v2 的 API 参考,由 Comfy Router 从 Elevenlabs 提供服务。
输入: 文本 · 输出: 音频
快速开始
在你的 Comfy 工作区中创建密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 进行的同一调用。
模型 ID: elevenlabs/eleven_sfx_v2
端点: POST https://api.comfy.org/v2/models/elevenlabs/eleven_sfx_v2
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "elevenlabs/eleven_sfx_v2", { "duration_seconds": 5, "text": "A distant rumble of thunder rolling across a valley.", }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("elevenlabs/eleven_sfx_v2", { duration_seconds: 5, text: "A distant rumble of thunder rolling across a valley.", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/elevenlabs/eleven_sfx_v2 \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"duration_seconds\": 5, \"text\": \"A distant rumble of thunder rolling across a valley.\"}"``
[tab] 排队并稍后收集 相同的请求体,发送至POST https://api.comfy.org/v2/models/elevenlabs/eleven_sfx_v2/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( "elevenlabs/eleven_sfx_v2", { "duration_seconds": 5, "text": "A distant rumble of thunder rolling across a valley.", }, ) 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("elevenlabs/eleven_sfx_v2", { duration_seconds: 5, text: "A distant rumble of thunder rolling across a valley.", }); 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/elevenlabs/eleven_sfx_v2/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"duration_seconds\": 5, \"text\": \"A distant rumble of thunder rolling across a valley.\"}" # 2. 轮询直到状态为 COMPLETED,每次响应都会指定需要等待的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/elevenlabs/eleven_sfx_v2/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。完成后返回 200 和模型的原生输出,仍在运行时返回 202 和状态体。 curl https://api.comfy.org/v2/models/elevenlabs/eleven_sfx_v2/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
duration\_seconds number required
将要生成的声音的时长,单位为秒。 必须至少为 0.5,最多为 30。 此路由上为必填:与上游 ElevenLabs API 不同(当该字段为 null 时, 上游会推测一个最佳时长),此路由会拒绝省略该字段的请求, 并返回 400 "Duration is required"。 该字段保持可为 null,只是为了让显式的 null 成为一个格式良好的 文档;它仍然会被拒绝。 该值是请求计量所依据的数量。
范围:0.5 到 30
格式:double
loop boolean (default: false)
是否创建可平滑循环的音效。 ElevenLabs 的文档说明此选项仅适用于 'eleven\_text\_to\_sound\_v2' 模型,而本路由正是把 'eleven\_sfx\_v2' 作为该模型转发的 (见 model\_id),因此在这里适用。
model\_id string
用于声音生成的模型 ID。此路由仅接受 'eleven\_sfx\_v2',其他任何值都会在请求到达 ElevenLabs 之前 被拒绝并返回 400。“eleven\_sfx\_v2”是 Comfy 为 ElevenLabs 称作“eleven\_text\_to\_sound\_v2”的模型所使用的 ID;代理会把转发出去的请求体改写成该厂商拼写,这是 ElevenLabs 自身枚举所要求的(它会以 422 拒绝“eleven\_sfx\_v2”),因此调用方永远不会发送厂商 ID。 它不在此模式的 required 列表中, 因为 Comfy Router 会从 /v2/models/elevenlabs/\{model} 的 {model} 路径段填充它,所以 Router 调用方会省略它。
prompt\_influence number
提示词影响越高,生成结果就越贴近提示词, 同时生成结果的多样性也会降低。 必须是 0 到 1 之间的值。默认为 0.3。
范围:0 到 1
格式:double
text string required
将被转换为音效的文本。
此内容根据 Router 在 GET /v2/models/elevenlabs/eleven_sfx_v2/openapi.json 提供的模式生成,该文档与它在请求到达提供商之前用于校验调用的文档相同。
输出
/ string (binary)
原始音频字节。Content-Type 和编码遵循所请求的 output\_format,并从 ElevenLabs 原样转发。示例是二进制主体的占位符,不是 JSON 或 base64。
示例
输入
{
"duration_seconds": 5,
"text": "A distant rumble of thunder rolling across a valley."
}
输出
二进制主体:原始字节而非 JSON 文档,以 */* 返回,因此没有可展示的 JSON 示例。响应的 Content-Type 和编码遵循请求,如上面的输出模式所述。
发布前须知
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 目前不支持的功能,以及替代方案。