worker-comfyui

ComfyUI 作为 RunPod 上的无服务器API

![RunPod]([***]

---

本项目允许在RunPod平台上将ComfyUI工作流作为无服务器API端点运行。通过API调用提交工作流，可接收base64字符串或S3 URL形式的生成图像。

目录

• 快速入门
• 可用Docker镜像
• API规范
• 使用方法
• 获取工作流JSON
• 更多文档

---

快速入门

1. 🐳 为你的无服务器端点选择一个可用Docker镜像（例如 runpod/worker-comfyui:<version>-sd3）。
2. 📄 按照部署指南设置RunPod模板和端点。
3. ⚙️ （可选）使用环境变量配置工作器（如S3上传）- 详见完整配置指南。
4. 🧪 从 test_resources/workflows/ 中选择示例工作流或获取你自己的工作流。
5. 🚀 按照以下使用方法与已部署的端点交互。

可用Docker镜像

以下镜像在Docker Hub上的 runpod/worker-comfyui 仓库可用：

• runpod/worker-comfyui:<version>-base：基础版ComfyUI安装，不包含模型。
• runpod/worker-comfyui:<version>-flux1-schnell：包含FLUX.1 schnell的检查点、文本编码器和VAE。
• runpod/worker-comfyui:<version>-flux1-dev：包含FLUX.1 dev的检查点、文本编码器和VAE。
• runpod/worker-comfyui:<version>-sdxl：包含Stable Diffusion XL的检查点和VAE。
• runpod/worker-comfyui:<version>-sd3：包含Stable Diffusion 3 medium的检查点。

将 <version> 替换为当前发布标签，查看发布页面获取最新版本。

API规范

工作器公开标准RunPod无服务器端点（/run、/runsync、/health）。默认情况下，图像以base64字符串形式返回，也可配置为S3 URL。通过环境变量可配置工作器（如S3上传）- 详见完整配置指南。

使用 /runsync 端点进行同步请求，等待作业完成并直接返回结果；使用 /run 端点进行异步请求，立即返回作业ID，需单独轮询 /status 端点获取结果。

输入

json
{
  "input": {
    "workflow": {
      "6": {
        "inputs": {
          "text": "a ball on the table",
          "clip": ["30", 1]
        },
        "class_type": "CLIPTextEncode",
        "_meta": {
          "title": "CLIP Text Encode (Positive Prompt)"
        }
      }
    },
    "images": [
      {
        "name": "input_image_1.png",
        "image": "data:image/png;base64,iVBOR..."
      }
    ]
  }
}

以下表格描述 input 对象中的字段：

input.images 对象

input.images 数组中的每个对象必须包含：

[!NOTE]

大小限制：RunPod端点有请求大小限制（例如 /run 为10MB，/runsync 为20MB）。大型base64输入图像可能超出这些限制。详见RunPod文档。

输出

[!WARNING]

输出格式重大变更（5.0.0+）

版本 < 5.0.0 将主要图像数据（S3 URL或base64字符串）直接返回到 outpu***ssage 字段中。 从 5.0.0 开始，输出格式发生重大变更，详见下文

json
{
  "id": "sync-uuid-string",
  "status": "COMPLETED",
  "output": {
    "images": [
      {
        "filename": "ComfyUI_00001_.png",
        "type": "base64",
        "data": "iVBORw0KGgoAAAANSUhEUg..."
      }
    ]
  },
  "delayTime": 123,
  "executionTime": 4567
}

output.images

output.images 数组中的每个对象结构如下：

[!NOTE] output.images 字段提供所有生成图像的列表（不包含临时图像）。

• 若未配置S3上传（默认），type 为 "base64"，data 包含base64编码图像字符串。
• 若已配置S3上传，type 为 "s3_url"，data 包含S3 URL。详见配置指南中的S3响应示例。
• 与API交互的客户端需要处理 output.images 下的列表结构。

使用方法

要与已部署的RunPod端点交互：

1. 获取API密钥：在RunPod 用户设置（API Keys 部分）生成密钥。
2. 获取端点ID：在无服务器端点页面或端点的概览页面找到端点ID。

生成图像（同步示例）

将工作流发送到 /runsync 端点（等待完成）。替换 <api_key> 和 <endpoint_id>。-d 值应包含上述JSON输入。

bash
curl -X POST \
  -H "Authorization: Bearer <api_key>" \
  -H "Content-Type: application/json" \
  -d '{"input":{"workflow":{... 你的工作流JSON ...}}}' \
  [***]<endpoint_id>/runsync

你也可使用 /run 端点进行异步作业，然后轮询 /status 查看作业状态。或在请求中添加webhook以在作业完成时接收通知。

详见 test_input.json 获取完整输入示例。

获取工作流JSON

要获取API所需的正确 workflow JSON：

1. 在浏览器中打开ComfyUI。
2. 在顶部导航栏选择 Workflow > Export (API)。
3. 将下载 workflow.json 文件。将文件内容用作API请求中 input.workflow 字段的值。

更多文档

• 部署指南：在RunPod上部署的详细步骤。
• 配置指南：环境变量完整列表（含S3设置）。
• 自定义指南：添加自定义模型和节点（网络卷、Docker构建）。
• 开发指南：设置本地开发和测试环境。
• CI/CD指南：Docker自动构建和发布工作流信息。
• 致谢： credits和感谢。