文档 /
开发 /
服务器概述
服务器概述
将 ComfyUI 作为服务器运行,通过 REST 和 WebSocket API 编程交互
开发
comms_overview 更新于 2026-06-08
服务器概述
将 ComfyUI 作为服务器运行,通过 REST 和 WebSocket API 编程交互
ComfyUI 默认作为 HTTP 服务器在本地运行。你可以通过编程方式调用它来提交工作流、上传文件、下载输出和监控进度 — 无需打开浏览器。
启动服务器
启动 ComfyUI 时会自动启动 HTTP 服务器,地址为 http://127.0.0.1:8188。
以无界面模式运行(不打开浏览器):
# 不打开浏览器运行
python main.py --disable-auto-launch
# 指定自定义端口
python main.py --port 8288
# 监听所有网络接口(用于远程访问)
python main.py --listen 0.0.0.0
[!TIP] 查看完整启动参数请运行 python main.py --help,或参阅启动参数参考。
本部分的关键页面
[card] 启动参数 main.py 全部命令行启动参数完整参考。
[card] API 路由 可用的 HTTP 端点:提交工作流、上传文件、查询状态。
[card] API 示例 调用 API 的代码示例:仅 HTTP、WebSocket + History、SaveImageWebsocket。
[card] 服务器消息 执行过程中服务器发送给客户端的 WebSocket 消息类型。
[card] 执行模型反转 高级:反转执行以实现自定义控制流。
使用 Partner Nodes
如果工作流包含付费 Partner Nodes,可在请求体中包含 API Key。详见 Partner Node API 集成 指南。
服务器工作原理
Comfy 服务器构建于 aiohttp 框架 基础之上,该框架则依赖于 asyncio 库。
服务器向客户端发送消息时,会通过 send_sync 方法(server.py 中定义的 PromptServer 类实例)以 socket 消息形式发送。这些消息由 api.js 中注册的 socket 事件监听器处理。参见消息传递。
客户端向服务器发送消息时,通过 api.js 中定义的 api.fetchApi() 方法,由服务器端设定的 HTTP 路由处理。参见路由机制。
[!TIP] 当请求加入队列时,客户端会提交完整的工作流(包括所有组件的当前值)。 一旦请求进入队列,服务器不会接收之后对工作流的任何修改。 若需在执行过程中动态调整服务器行为,需要使用路由机制。