Skip to main content
ComfyUI 提供多种 API 选项,具体取决于您希望在哪里运行工作流,以及希望管理多少基础设施。本页可帮助您选择合适的方法。

从这里开始

对于新的集成,请使用 Comfy SDKs 及其调用的 Comfy API v2。v2 是一套新的、带版本管理的 HTTP 接口,与现有的 Cloud API 和 ComfyUI Server API 并存。详见 Comfy API v2 概览。同一套代码既可运行于 Comfy Cloud,也可运行于您自己的机器。

Comfy SDKs

用于从您自己的应用程序中运行工作流的官方 Python 与 TypeScript SDK。目前处于测试版。
以下其他 API 仍完全受支持,它们涵盖了 SDK 尚未覆盖的范围。此处没有任何内容被弃用。

我应该使用哪个 API?

它们都使用相同的工作流格式(API 格式),因此你可以在本地开发和测试工作流,并将其移至云端而无需更改。

入门

Comfy SDKs

使用 Python 或 TypeScript 运行工作流,可对接云端或您自己的机器。

云端 API

在 Comfy 的托管基础设施上运行工作流。无需设置 GPU。

ComfyUI 服务器 API

在您自己的机器上将 ComfyUI 作为服务器运行,并通过 API 调用。

合作节点 API 集成

在无头或 API 驱动的工作流中使用付费合作节点。

先决条件

在使用任何 API 之前,你需要:
  • 任何涉及 Comfy Cloud 或合作节点的操作都需要 API 密钥(参见 获取 API 密钥)。纯本地 ComfyUI 则不需要。