> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-docs-robin-i18n-sync.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 运行工作流

> 如何针对实时部署运行 ComfyUI 工作流，以及哪个客户端适用于哪种部署

ComfyUI [部署到某处](/zh/development/deploy/overview)后，您的应用程序便可针对它运行工作流：提交工作流，等待执行，然后下载输出。本页面梳理了每种部署方式分别应使用哪个客户端。

## Start here: the Comfy SDKs

For a new integration, use the official **Comfy SDKs** (Python and TypeScript) and the [Comfy API v2](/api-reference/v2/overview) they call. The same code runs against every deployment target; only the base URL changes.

<Card title="Comfy SDKs" icon="code" href="/development/api-development/sdks">
  Install the SDK, submit a workflow, and download the outputs. Currently in beta.
</Card>

## 什么和什么兼容

| 部署方式                  | Comfy SDK / API v2                                       | 备注                                                                      |
| --------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------- |
| **Serverless API 部署** | 支持                                                       | 将 `COMFY_BASE_URL` 指向 `https://<deployment>.run.comfy.app`，并使用你的 API 密钥 |
| **Comfy Cloud**       | 支持                                                       | 默认基础 URL。需要 API 密钥和付费订阅                                                 |
| **自托管**               | 支持，通过 [API 代理](/zh/development/comfyui-server/api-proxy) | 在 v2 测试版期间，由与 ComfyUI 一起运行的小型服务提供 v2 API                                |

自托管实例也可以完全跳过 SDK，直接使用原生 [ComfyUI 服务器 API](/zh/development/comfyui-server/comms_overview)（REST + WebSocket）。它暴露完整的本地接口，包括队列和节点信息，但不保证跨版本兼容。

## 应该使用哪个 API？

|           | Comfy API v2 + SDKs                                                 | v1 Cloud API                    | ComfyUI Server API    |
| --------- | ------------------------------------------------------------------- | ------------------------------- | --------------------- |
| **运行位置**  | Serverless 部署、Comfy Cloud，或通过 API Proxy 自托管                         | 仅限 Comfy Cloud                  | 仅限自托管                 |
| **兼容性**   | 带版本号，仅在 v2 内进行增量变更                                                  | 已弃用，可能随时更改，恕不另行通知               | 不保证各版本之间兼容            |
| **身份验证**  | 云端和 Serverless 使用 `Authorization: Bearer`。自托管：默认无，可选静态 bearer token | `X-API-Key` 请求头（Comfy Cloud 账户） | 无（本地），或为合作节点使用 API 密钥 |
| **官方客户端** | Python 和 TypeScript SDK                                             | 无，通过 HTTP 调用                    | 无，通过 HTTP 调用          |
| **协议**    | REST + SSE                                                          | REST + WebSocket                | REST + WebSocket      |
| **范围**    | 运行工作流并获取结果                                                          | 完整的 Cloud 功能，包括模型和账户            | 完整的本地功能，包括队列和节点信息     |
| **最适合**   | 需要长期保持可用的新集成                                                        | 现有集成以及 v2 尚未覆盖的 Cloud 功能        | 完全控制，针对自有实例的自定义工具     |

所有这些 API 都接受相同的工作流格式（[API 格式](/zh/development/api-development/workflow-api-format)），因此你可以在本地开发和测试工作流，并将其迁移到其他部署环境，无需任何更改。

## 入门

<CardGroup cols={2}>
  <Card title="Comfy SDK" icon="code" href="/zh/development/api-development/sdks">
    使用 Python 或 TypeScript 针对任何部署目标运行工作流。
  </Card>

  <Card title="自托管 API 代理" icon="plug" href="/zh/development/comfyui-server/api-proxy">
    在你自己的 ComfyUI 前面提供 v2 API，以便 SDK 可以访问它。
  </Card>

  <Card title="工作流 API 格式" icon="file-code" href="/zh/development/api-development/workflow-api-format">
    以 API 接受的 JSON 格式导出工作流。
  </Card>

  <Card title="ComfyUI 服务器 API" icon="server" href="/zh/development/comfyui-server/comms_overview">
    自托管实例的原始 REST 和 WebSocket API。
  </Card>
</CardGroup>

## 前提条件

* 任何涉及 Comfy Cloud、Serverless 部署或合作节点的操作都需要 [API 密钥](/zh/development/api-development/getting-an-api-key)。纯本地运行的 ComfyUI 则不需要。
* 以 [API 格式](/zh/development/api-development/workflow-api-format) 导出的工作流。