开发与 API
API 总览
通过不同方式编程调用 ComfyUI 的接口概览
ComfyUI 提供多种 API 选项,取决于你希望在哪里运行工作流以及你想管理多少基础设施。本页帮助你选择合适的方式。
我应该用哪种 API?
| Cloud API | ComfyUI Server API | |
|---|---|---|
| 在哪运行 | Comfy Cloud(托管 GPU) | 你自己的机器 |
| GPU 管理 | 无需操心 | 自己管理硬件 |
| 模型 | 云端预装并由 Comfy 管理 | 自行下载和管理模型 |
| 认证 | X-API-Key 请求头 |
无(本地)或 API Key(Partner Nodes) |
| 基础地址 | https://cloud.comfy.org |
你自己的服务器地址(例如 http://localhost:8188) |
| 协议 | REST + WebSocket | REST + WebSocket |
| 价格 | 订阅制(Creator/Pro 等级) | 免费(用你自己的算力) |
| 适合场景 | 快速集成,无需管理基础设施 | 完全控制、自定义硬件和模型 |
两种 API 使用相同的 API 格式 工作流,你可以在本地开发和测试工作流,然后直接迁移到云端。
快速开始
Cloud API
在 Comfy 托管的基础设施上运行工作流。无需 GPU 设置。
ComfyUI Server API
将 ComfyUI 作为服务器在本地运行,通过 API 调用。
Partner Node API 集成
在无界面或 API 驱动的工作流中使用付费 Partner Nodes。
前提条件
- 一个 API Key(参见获取 API Key)
官方原文
本页来自 Comfy-Org 官方中文文档的固定版本,并转换为 xueai 静态页面。内容以官方持续更新的页面为准。