Skip to main content
测试版： Comfy API v2 目前处于 0.1.x 版本，接口可能仍会变化。v2 内的变更将是增量式的；任何破坏性变更都将以 v3 形式发布。
用于从外部应用运行 ComfyUI 工作流的官方版本化 HTTP API：上传输入、提交工作流、观察执行、获取结果。 大多数人应该从 Comfy SDK 开始，这些 SDK 使用 Python 和 TypeScript 封装了此 API。如果您使用其他语言，可以直接调用这些端点。完整的端点文档位于本节的 API 参考页面中，由 OpenAPI 规范生成。

​
v2 在哪里运行

同一个 API 由三种形态提供，因此只需更改基础 URL，同一份集成即可在它们之间迁移。 Comfy Cloud。 位于 https://cloud.comfy.org 的托管多租户服务。创建 API 密钥 后即可提交任何工作流。积分、模型浏览和队列管理等 Cloud 特有功能位于 v1 Cloud API，而不在 v2 上。 Comfy API 部署。 通过开发者平台部署的环境会获得位于 https://{deployment}.run.comfy.app 的专属端点，它提供相同的 v2 API 和相同的 API 密钥。Comfy API 部署会针对一个固定环境运行工作流，因此可以独立扩缩，并且 GET /workflow 会返回实际执行的图。构建与部署请参见 Comfy API 部署指南。 开源 ComfyUI，通过代理。 在测试版期间，自托管的 ComfyUI 通过 comfy-api-proxy 来使用 v2 协议，这是一个与它一起运行的小型开源服务：
默认情况下，它代理 127.0.0.1:8188 上的 ComfyUI，并在 127.0.0.1:8189 上提供 v2 API，仅绑定到回环地址。默认关闭身份验证，可选择使用静态 bearer 令牌。该代理只是权宜之计：一旦 v2 稳定下来，它就会并入 ComfyUI 核心，届时不再需要代理。配置细节请参见 SDK 指南中的您自己的 ComfyUI。

​
设计原则

  • 优先轮询。 每项能力都可以通过简单的 GET 轮询访问。SSE 流是实时增强，绝不是事实来源。
  • 一切皆可恢复。 提交是幂等的，在 expires_at 之前，任务状态和输出均可通过 ID 检索。
  • 内容寻址资产。 资产是基于内容寻址 blob 的 UUID 标识记录，blob 以服务器计算的 blake3 哈希为键，因此相同的输入不会被重复上传。
  • 跟随链接，不要自行构造 URL。 响应中嵌入了后续 URL。
想了解这些设计背后的原因，请参阅 设计说明。

​
基础 URL

​
端点分类

​
Comfy Router

Comfy API v2 通过提交并轮询的持久任务来运行工作流。如需直接调用模型（单个合作伙伴模型、单个请求、模型的原生输入和输出），请参阅 Comfy Router。请先阅读 Router 限制。Router 目前尚未正式推出。