运行工作流

如何针对线上部署运行 ComfyUI 工作流，以及哪种客户端适用于哪种部署

ComfyUI 部署到某处之后，你的应用程序便可针对其运行工作流：提交工作流、等待执行、下载输出。本页梳理了不同的部署方式分别应使用哪种客户端。

​

从这里开始：Comfy SDK

对于新的集成，请使用官方 Comfy SDK（Python 和 TypeScript）以及它们所调用的 Comfy API v2。同一份代码可在所有部署目标上运行，只需更改 base URL。

Comfy SDKs

安装 SDK、提交工作流并下载输出。目前处于测试版。

​

什么与什么搭配使用

部署方式	Comfy SDK / API v2	说明
Comfy API 部署	支持	将 COMFY_BASE_URL 指向 https://<deployment>.run.comfy.app，并附上你的 API 密钥
Comfy Cloud	支持	默认的 base URL。需要 API 密钥和付费订阅
自托管	支持，通过 API Proxy	在 v2 测试版期间，由 ComfyUI 旁边的一个小型服务提供 v2 API

自托管的实例也可以完全跳过 SDK，直接使用原生的 ComfyUI Server API（REST + WebSocket）。它暴露了完整的本地能力，包括队列和节点信息，但不保证跨版本兼容。

​

我应该使用哪个 API？

	Comfy API v2 + SDKs	v1 Cloud API	ComfyUI Server API
运行位置	Comfy API 部署、Comfy Cloud，或通过 API Proxy 自托管	仅限 Comfy Cloud	仅限自托管
兼容性	有版本管理，v2 内仅做增量变更	已弃用，可能在不通知的情况下变更	跨版本不保证
身份验证	在 Comfy Cloud 和 Comfy API 部署上使用 Authorization: Bearer。自托管：默认无，可选静态 bearer token	X-API-Key 请求头（Comfy Cloud 账户）	无（本地），或用于合作节点的 API 密钥
官方客户端	Python 和 TypeScript SDK	无，直接通过 HTTP 调用	无，直接通过 HTTP 调用
协议	REST + SSE	REST + WebSocket	REST + WebSocket
范围	运行工作流并获取结果	完整的云端功能面，包括模型和账户	完整的本地功能面，包括队列和节点信息
适用场景	需要长期稳定运行的新集成	现有集成，以及 v2 尚未覆盖的云端功能	完全控制，可针对你自己的实例构建自定义工具

它们都接受相同的工作流格式（API 格式），因此你可以在本地开发和测试工作流，然后无需修改即可将其迁移到另一个部署。

​

入门

Comfy SDK

从 Python 或 TypeScript 运行工作流，适用于任何部署目标。

自托管 API 代理

在你自己的 ComfyUI 前面提供 v2 API 服务，以便 SDK 能够访问它。

工作流 API 格式

以 API 接受的 JSON 格式导出工作流。

ComfyUI 服务器 API

自托管实例的原始 REST 和 WebSocket API。

​

前置条件

• 凡是涉及 Comfy Cloud、Comfy API 部署或合作节点(Partner Nodes)的场景,都需要一个 API 密钥。纯本地运行的 ComfyUI 则无需 API 密钥。
• 以 API 格式 导出的工作流。