运行你的第一个工作流

在 Comfy Cloud 上运行示例工作流,并使用 Python 或 TypeScript 下载其输出。

通过代码运行一个完整的工作流，并将其输出保存为 first-result.png。这个示例使用两个内置节点创建一张 512 × 512 的纯蓝色图像。它无需模型、输入图像或自定义节点，即可验证身份认证、工作流执行和输出下载。

若要直接调用托管模型来生成图像，请从 Comfy Router 快速入门 开始。

​

开始之前

• 一个 Comfy API 密钥。
• 一个付费的 Comfy Cloud 订阅。云端工作流 API 访问不包含在免费层级中。
• Python 3.10 或更高版本，或者用于 TypeScript 示例的 Node.js 22.18 或更高版本。

本指南使用 Comfy Cloud，即 SDK 的默认目标。如果你之前设置过 COMFY_BASE_URL，请将其取消设置以使用 Cloud。对于现有的 Comfy API 部署或自托管实例，请参阅选择基础 URL。

​

1. 下载示例

为示例创建一个文件夹。将 workflow_api.json 和对应语言的脚本下载到该文件夹中：

• Python：first_workflow.py
• TypeScript：first_workflow.mts

该工作流已采用 API 格式。节点 "1" 创建蓝色图像，节点 "2" 负责保存它。脚本会从这个确切的 SaveImage 节点读取输出，因此你无需查找或编辑任何节点 ID。

​

2. 安装 SDK 并设置密钥

在保存文件所在的文件夹中打开终端。

Python

python -m venv .venv
source .venv/bin/activate
python -m pip install comfy-sdk

在 Windows 上，请在 PowerShell 中使用 .venv\Scripts\Activate.ps1 激活 Python 环境。

在同一终端中设置你的密钥：

macOS / Linux

export COMFY_API_KEY="comfyui-your-key"

请将 API 密钥保存在服务器环境中。不要将其放入浏览器代码，也不要提交到源代码管理中。

​

3. 运行并查看结果

Python

python first_workflow.py

该脚本会提交工作流、等待其完成并下载图像。当它输出 Saved 及其后的路径时，打开该位置中的 first-result.png。你应该会看到一个纯蓝色方块。再次运行示例会覆盖该本地文件。

这是一次工作流连接检查，不使用生成模型。同样的提交、等待和下载步骤也适用于你自己的生成工作流。

​

如果请求失败

• 密钥缺失或未授权： 检查运行脚本的终端中是否已设置 COMFY_API_KEY，并且其中包含有效的密钥。
• 访问或积分错误： 重试之前，请检查你的云端订阅和可用积分。
• 未找到工作流文件： 将 workflow_api.json 与下载的脚本放在一起。
• 意外的端点： 检查 COMFY_BASE_URL。在此云端示例中请将其取消设置。

有关错误处理和任务进度，请参阅 SDK 指南。

​

4. 运行你自己的生成工作流

在 ComfyUI 编辑器中构建或选择一个工作流，在编辑器中成功运行它，然后以 API 格式导出。用你导出的文件替换 workflow_api.json，并更新 Python 中的 get_outputs("2") 或 TypeScript 中的 getOutputs("2")，改用你的工作流中 SaveImage 节点的 ID。检查目标环境是否具备你的工作流所使用的模型和自定义节点。

要托管带有你自己的模型和自定义节点的工作流，请创建 Comfy API 部署。如需更改工作流输入、上传文件或查看进度，请继续阅读 Comfy SDKs。