beeble/switchx 的 API 参考,由 Comfy Router 提供,来自 Beeble。
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk);cURL 代码片段是通过原始 HTTP 发出的相同调用。
模型 ID: beeble/switchx
端点: POST https://api.comfy.org/v2/models/beeble/switchx
- Wait for the result
- Queue and collect later
Schema
Input
string
必填
透明度模式:自动、填充、自定义或选择可选值:
auto、fill、custom、selectstring
自定义透明度蒙版的 URI。当 alpha_mode 为 custom 或 select 时必填。在 auto 或 fill 模式下会被忽略。
string
用于在任务完成或失败时接收 webhook 通知的 HTTPS URL。
string
必填
输出类型:图像或视频可选值:
image、videostring
用于安全重试的幂等键。如果你的账号下已存在使用相同键的任务,API 会返回现有任务的状态,而不会创建重复任务。
integer
默认值:"1080"
最大输出分辨率:720 或 1080(默认值:1080)。
string
期望输出的文本描述(最多 2,000 个字符)。prompt 与 reference_image_uri 至少需要提供一个。
string
用于风格迁移的参考图像 URI。接受的 URI 类型与 source_uri 相同。
string
必填
来源图像或视频的 URI。接受 beeble://uploads/{id}/{filename}、https URL 或 data:{mime};base64 URI(最大 50 MB)。
GET /v2/models/beeble/switchx/openapi.json 提供的 schema 生成,Router 在请求到达提供商之前,正是用这份文档来校验调用。
Output
string
自动、填充、自定义或选择
string
任务完成或失败时的 ISO 8601 时间戳。
string
任务创建时的 ISO 8601 时间戳。
string
报错信息(status 为 failed 时存在)。
string
图像或视频
string
必填
任务标识符(swx_…)
string
最后一次状态变更的 ISO 8601 时间戳。
object
SwitchX 任务输出的签名 URL。
string
透明度蒙版 URL。
string
合成后的输出 URL。
string
预处理后的来源 URL。
integer
进度百分比(0-100)。
string
必填
当前任务状态。可选值:
in_queue、processing、completed、failedobject
SwitchX 任务的 webhook 投递状态。
integer
到目前为止的投递尝试次数。
string
最后一次失败投递尝试的报错信息。
string
待定、已投递或失败
示例
输入
输出
发布前须知
SDK 会生成Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载,因为结果链接会过期。
请求头
身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
使用 Router API
模型发现、校验错误、重试与计费。
限制
Router 目前不支持的功能,以及替代方案。