> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-sync-comfy-api-v2-spec-462120c.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# API 总览

> 通过不同方式编程调用 ComfyUI 的接口概览

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

***

## 从这里开始

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

<Card title="Comfy SDKs" icon="code" href="/zh/development/api-development/sdks">
  用于从您自己的应用程序中运行工作流的官方 Python 与 TypeScript SDK。目前处于测试版。
</Card>

以下其他 API 仍完全受支持，它们涵盖了 SDK 尚未覆盖的范围。此处没有任何内容被弃用。

***

## 我应该使用哪个 API？

|            | Comfy API v2 + SDKs                                  | Cloud API                       | ComfyUI Server API                    |
| ---------- | ---------------------------------------------------- | ------------------------------- | ------------------------------------- |
| **运行位置**   | Comfy Cloud，或通过本地代理在你自己的机器上运行                        | Comfy Cloud（托管 GPU）             | 你自己的机器                                |
| **兼容性**    | 有版本控制，v2 内仅做增量更改                                     | 实验性，可能随时更改，恕不另行通知               | 跨版本不提供保证                              |
| **GPU 管理** | 取决于你指向哪个接口                                           | 为你处理                            | 你自行管理自己的硬件                            |
| **模型**     | 取决于你指向哪个接口                                           | 由 Comfy 预装和管理                   | 你自行下载并在本地管理                           |
| **身份验证**   | 云端使用 `Authorization: Bearer`。自托管默认无认证，可选静态 bearer 令牌 | `X-API-Key` 请求头（Comfy Cloud 账户） | 无（本地）或用于合作节点的 API 密钥                  |
| **基础 URL** | `https://cloud.comfy.org` 或 `http://127.0.0.1:8189`  | `https://cloud.comfy.org`       | 你的服务器 URL（例如 `http://localhost:8188`） |
| **官方客户端**  | Python 和 TypeScript SDK                              | 无，通过 HTTP 调用                    | 无，通过 HTTP 调用                          |
| **协议**     | REST + SSE                                           | REST + WebSocket                | REST + WebSocket                      |
| **范围**     | 运行工作流并获取结果                                           | 完整的云端功能范围，包括模型和账户               | 完整的本地功能范围，包括队列和节点信息                   |
| **最适合**    | 需要长期保持可用的新集成                                         | SDK 尚未覆盖的云端功能                   | 完全控制、自定义硬件和模型                         |

它们都使用相同的工作流格式（[API 格式](/zh/development/api-development/workflow-api-format)），因此你可以在本地开发和测试工作流，并将其移至云端而无需更改。

## 入门

<CardGroup cols={2}>
  <Card title="Comfy SDKs" icon="code" href="/zh/development/api-development/sdks">
    使用 Python 或 TypeScript 运行工作流，可对接云端或您自己的机器。
  </Card>

  <Card title="云端 API" icon="cloud" href="/zh/development/cloud/overview">
    在 Comfy 的托管基础设施上运行工作流。无需设置 GPU。
  </Card>

  <Card title="ComfyUI 服务器 API" icon="server" href="/zh/development/comfyui-server/comms_overview">
    在您自己的机器上将 ComfyUI 作为服务器运行，并通过 API 调用。
  </Card>

  <Card title="合作节点 API 集成" icon="key" href="/zh/development/comfyui-server/api-key-integration">
    在无头或 API 驱动的工作流中使用付费合作节点。
  </Card>
</CardGroup>

***

## 先决条件

在使用任何 API 之前，你需要：

* 任何涉及 Comfy Cloud 或合作节点的操作都需要 API 密钥（参见 [获取 API 密钥](/zh/development/api-development/getting-an-api-key)）。纯本地 ComfyUI 则不需要。