> ## 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 是一个模块化的 GenAI 推理引擎，可以部署为服务器、通过 API 访问、用自定义节点扩展，并通过命令行管理。大多数 API 相关工作分为两步：先让 ComfyUI 在某个环境中运行起来，然后从你的应用程序对它运行工作流。

## 快速开始

试用 API 最快的方式是使用 Comfy Cloud 运行工作流。无需部署任何内容：SDK 默认指向 Comfy Cloud，因此你只需要一个工作流和一个 [API 密钥](/zh/development/api-development/getting-an-api-key)。

<Steps>
  <Step title="获取工作流">
    浏览 [ComfyUI 工作流](https://comfy.org/workflows) 中的社区工作流，或在编辑器中构建自己的工作流。将其以 [API 格式](/zh/development/api-development/workflow-api-format) 保存为 `workflow_api.json` 文件。
  </Step>

  <Step title="安装 SDK">
    <CodeGroup>
      ```bash Python theme={null}
      pip install comfy-sdk
      ```

      ```bash TypeScript theme={null}
      npm i @comfyorg/sdk
      ```
    </CodeGroup>
  </Step>

  <Step title="运行它">
    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      client = Comfy(api_key="comfyui-...")  # Comfy Cloud is the default target

      wf = client.workflows.from_file("workflow_api.json")

      job = client.run(wf)
      for output in job.get_outputs("9"):
          output.to_file(output.name)
      ```

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

      const client = new Comfy({ apiKey: "comfyui-..." }); // Comfy Cloud is the default target

      const wf = await client.workflows.fromFile("workflow_api.json");

      const job = await client.run(wf);
      await job.getOutputs("9")[0].toFile("out.png");
      ```
    </CodeGroup>

    `"9"` 是工作流文件中输出节点的 ID。有关输入、进度事件和错误处理，请参阅 [SDK 指南](/zh/development/api-development/sdks)。
  </Step>

  <Step title="部署你自己的 ComfyUI">
    当你需要在端点背后使用自己的模型和自定义节点时，可使用 [Serverless API](/zh/development/serverless/overview) 部署你的环境。相同的 SDK 代码同样适用于该环境，只需更改基础 URL 即可。
  </Step>
</Steps>

## 部署 ComfyUI

了解如何在开发者平台或您自己的基础设施上部署和扩展 ComfyUI。

<Card title="部署概览" icon="map" href="/zh/development/deploy/overview">
  比较 Serverless API、Comfy Cloud 和自托管，并选择合适的目标。
</Card>

另请参阅：[Serverless API](/zh/development/serverless/overview) · [Comfy Cloud](/zh/development/deploy/cloud) · [自托管选项](/zh/development/deploy/self-hosting)

## 运行工作流

了解如何使用我们的 SDK 和 v2 HTTP API 运行工作流。它们与我们的无服务器 API 端点以及你自己的 ComfyUI 实例配合使用。

<Card title="运行工作流" icon="play" href="/zh/development/run-workflows/overview">
  了解哪个客户端适用于哪种部署，先从 Python 和 TypeScript SDK 开始。
</Card>

另请参阅：[Comfy SDK](/zh/development/api-development/sdks) · [自托管 API 代理](/zh/development/comfyui-server/api-proxy) · [Comfy API v2 参考](/zh/api-reference/v2/overview)

## Agent Tools / MCP

通过模型上下文协议（MCP）将 AI 代理连接到 ComfyUI。可从托管的 Cloud MCP 开始，或使用 Local MCP 与 Comfy CLI 完成其他场景。

<Card title="MCP 概览" icon="robot" href="/zh/agent-tools">
  比较 Cloud MCP、Local MCP 和 Comfy CLI，找到适合你 AI 代理集成的方式。
</Card>

另见：[Comfy MCP](/zh/agent-tools/mcp)：云端与本地连接

## 更多

<CardGroup cols={2}>
  <Card title="自托管服务器 API" icon="server" href="/zh/development/comfyui-server/comms_overview">
    ComfyUI 服务器的原始 REST 和 WebSocket API：路由、消息和启动标志。
  </Card>

  <Card title="Comfy CLI" icon="terminal" href="/zh/comfy-cli/getting-started">
    从终端安装、更新和管理 ComfyUI。
  </Card>

  <Card title="自定义节点" icon="puzzle-piece" href="/zh/custom-nodes/overview">
    使用 Python 后端和 JavaScript UI 扩展来扩展 ComfyUI。
  </Card>

  <Card title="注册中心" icon="box-open" href="/zh/registry/overview">
    通过 Comfy Registry 打包和发布自定义节点。
  </Card>
</CardGroup>