跳转到主要内容
实验性 API: 此 API 处于实验阶段,可能会发生变化。端点、请求/响应格式和行为可能会在未事先通知的情况下进行修改。部分端点为兼容本地 ComfyUI 而保留,但可能具有不同的语义(例如,某些字段会被忽略)。
本页面提供了常见 Comfy Cloud API 操作的完整示例。
需要订阅: 通过 API 运行工作流需要有效的 Comfy Cloud 订阅。请查看定价方案了解详情。

设置

所有示例都使用以下通用的导入和配置:

对象信息

获取可用的节点定义。这对于了解可用的节点及其输入/输出规范非常有用。

上传输入

上传图像、遮罩或其他文件以在工作流中使用。

直接上传(Multipart)

上传遮罩

subfolder 参数为 API 兼容性而接受,但在云存储中会被忽略。所有文件都存储在扁平的、内容寻址的命名空间中。

运行工作流

提交工作流以执行。
支持并发提交: 根据您的订阅等级,您可以提交多个工作流而无需等待之前的任务完成。任务会根据您的等级限制并行运行——超出的任务会自动排队。详情及并发限制请参阅并行执行

提交工作流

使用合作伙伴节点

如果您的工作流包含合作伙伴节点(调用外部 AI 服务的节点,如 Flux Pro、Ideogram 等),您必须在请求体的 extra_data 字段中包含您的 Comfy API 密钥。
在浏览器中运行工作流时,ComfyUI 前端会自动将您的 API 密钥打包到 extra_data 中。本节仅适用于直接调用 API 的情况。
platform.comfy.org 生成您的 API 密钥。此密钥与 Cloud API 身份验证(X-API-Key 请求头)使用的是同一个密钥。请参阅获取 API 密钥了解详细步骤。

修改工作流输入


检查任务状态

任务状态值: API 返回以下状态值之一:
状态描述
pending任务已排队,等待开始
in_progress任务正在执行
completed任务成功完成
failed任务遇到错误
cancelled任务被用户取消

实时进度 WebSocket

连接 WebSocket 以获取实时执行更新。
clientId 参数目前会被忽略——同一用户的所有连接都会收到相同的消息。为了向前兼容,仍建议传递唯一的 clientId

WebSocket 消息类型

消息以 JSON 文本帧的形式发送,除非另有说明。
类型描述
status队列状态更新,包含 queue_remaining 计数
notification用户友好的状态消息(value 字段包含如 “Executing workflow…” 的文本)
execution_start工作流执行已开始
executing特定节点正在执行(节点 ID 在 node 字段中)
progress节点内的步骤进度(采样步骤的 value/max
progress_state扩展进度状态,包含节点元数据(嵌套的 nodes 对象)
executed节点完成并输出结果(图像、视频等在 output 字段中)
execution_cached因输出已缓存而跳过的节点(nodes 数组)
execution_success整个工作流成功完成
execution_error工作流失败(包含 exception_typeexception_messagetraceback
execution_interrupted工作流被用户取消

二进制消息(预览图像)

在图像生成过程中,ComfyUI 会发送包含预览图像的二进制 WebSocket 帧。这些是原始二进制数据(不是 JSON):
二进制类型描述
PREVIEW_IMAGE1扩散采样期间的进度预览
TEXT3节点的文本输出(进度文本)
PREVIEW_IMAGE_WITH_METADATA4带有节点上下文元数据的预览图像
二进制帧格式(所有整数为大端序):
偏移大小字段描述
04 字节type0x00000001
44 字节image_type格式代码(1=JPEG, 2=PNG)
8可变image_data原始图像字节
请参阅 OpenAPI 规范 了解每种 JSON 消息类型的完整模式定义。

下载输出

在任务完成后检索生成的文件。

完整端到端示例

以下是一个将所有内容整合在一起的完整示例:

队列管理

获取队列状态

取消任务

中断当前执行


错误处理

HTTP 错误

REST API 端点返回标准 HTTP 状态码:
状态码描述
400无效请求(错误的工作流、缺少字段)
401未授权(无效或缺少 API 密钥)
402积分不足
429订阅未激活
500内部服务器错误

执行错误

在工作流执行期间,错误通过 execution_error WebSocket 消息传递。exception_type 字段标识错误类别:
异常类型描述
ValidationError无效的工作流或输入
ModelDownloadError所需模型不可用或下载失败
ImageDownloadError从 URL 下载输入图像失败
OOMErrorGPU 内存不足
InsufficientFundsError账户积分不足(用于合作伙伴节点)
InactiveSubscriptionError订阅未激活