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

# 自托管 ComfyUI 的 API 代理

> 在你自己的 ComfyUI 前面提供 Comfy API v2 服务，让官方 SDK 能够针对它运行工作流

[Comfy SDK](/zh/development/api-development/sdks) 使用 [Comfy API v2](/zh/api-reference/v2/overview)。在测试版期间，自托管的 ComfyUI 本身并不提供 v2 服务。[comfy-api-proxy](https://github.com/Comfy-Org/comfy-api-proxy) 是一个小型开源服务，它与你的实例一起运行，并在其前面提供 v2 契约。

<Note>
  代理只是一个临时方案。一旦 v2 API 稳定下来，它就会并入 ComfyUI 核心，届时便不再需要代理。
</Note>

## 安装并运行

```bash theme={null}
pip install comfy-api-proxy
comfy-api-proxy
```

默认情况下，它会代理 `127.0.0.1:8188` 上的 ComfyUI，并在 `127.0.0.1:8189` 上提供 v2 API 服务。使用 `--comfyui` 和 `--port` 可更改任意一项。

如果你还想将模型文件上传到你的安装目录中，请使用 `--comfyui-base-dir /path/to/ComfyUI` 运行它。

## 让 SDK 指向它

设置基础 URL，并像往常一样构造客户端：

```bash theme={null}
export COMFY_BASE_URL="http://127.0.0.1:8189"
```

<CodeGroup>
  ```python Python theme={null}
  from comfy_sdk import Comfy

  client = Comfy()
  ```

  ```typescript TypeScript theme={null}
  import { Comfy } from "@comfyorg/sdk";

  const client = new Comfy();
  ```
</CodeGroup>

[SDK 指南](/zh/development/api-development/sdks)中的所有内容，针对代理与针对 Comfy Cloud 的使用方式完全相同。

## 身份验证

默认情况下不需要身份验证。如果代理配置了静态 bearer token，请将该 token 作为 SDK 的 API 密钥传入：`Comfy(api_key="...")`。

<Warning>
  默认情况下，代理仅绑定到环回地址。如果你要将其暴露到环回之外，例如放在租用 GPU 上的 ComfyUI 前面，请配置 bearer token，或在其前面放置一个带身份验证的反向代理。
</Warning>

## 后续步骤

* [Comfy SDK](/zh/development/api-development/sdks)：客户端指南
* [Comfy API v2 参考](/zh/api-reference/v2/overview)：代理所提供的 HTTP 契约
* [自托管选项](/zh/development/deploy/self-hosting)：在其后面运行 ComfyUI 的位置
* [设计说明](/zh/development/api-development/sdks-design#本地代理)：代理存在的原因