Cloud API 概述

通过编程方式访问 Comfy Cloud，在云端运行工作流、管理文件并监控执行状态

实验性 API： 此 API 目前处于实验阶段，可能会发生变更。端点、请求/响应格式和行为可能会在不另行通知的情况下进行修改。

​

Comfy Cloud API

Comfy Cloud API 提供以编程方式访问 Comfy Cloud 的能力，可在云端基础设施上运行工作流。该 API 与本地 ComfyUI 的 API 兼容，便于迁移现有集成。

需要订阅： 通过 API 运行工作流需要有效的 Comfy Cloud 订阅。详情请参阅定价方案。

​

基础 URL

https://cloud.comfy.org

​

身份验证

所有 API 请求都需要通过 X-API-Key 请求头传递 API 密钥。

​

获取 API 密钥

1. 访问 https://platform.comfy.org/login 并登录

   请访问 https://platform.comfy.org/login 并使用相应账户登录

   
2. 点击 API Keys 中的 `+ New` 创建 API 密钥

   点击 API Keys 中的 + New 创建 API Key

   
3. 输入 API 密钥名称

   

   1. （必填）输入 API Key 名称，
   2. 点击 Generate 生成
4. 保存获取的 API 密钥

   

   由于 API Key 仅在首次创建时可见，请在创建后立即保存。之后将无法再次查看，请妥善保管。 请注意不要与他人分享您的 API Key。一旦泄露，您可以删除它并创建新的。

请妥善保管您的 API 密钥。切勿将其提交到版本控制系统或公开分享。

​

使用 API 密钥

在每个请求中通过 X-API-Key 请求头传递您的 API 密钥：

curl

curl -X GET "https://cloud.comfy.org/api/user" \
  -H "X-API-Key: $COMFY_CLOUD_API_KEY"

​

核心概念

​

工作流

ComfyUI 工作流是描述节点图的 JSON 对象。API 接受”API 格式”的工作流（以节点 ID 为键，包含 class_type、inputs 等），该格式由 ComfyUI 前端的”Save (API Format)“选项导出。

​

任务

当您提交工作流时，会创建一个任务。任务以异步方式执行：

1. 通过 POST /api/prompt 提交工作流
2. 收到 prompt_id（任务 ID）
3. 通过 WebSocket 监控进度或轮询状态
4. 完成后获取输出

​

输出

生成的内容（图像、视频、音频）存储在云存储中。输出文件可通过 /api/view 端点或签名 URL 下载。

​

快速入门

以下是运行工作流的最小示例：

curl

curl -X POST "https://cloud.comfy.org/api/prompt" \
  -H "X-API-Key: $COMFY_CLOUD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": '"$(cat workflow_api.json)"'}'

​

可用端点

类别	描述
工作流	提交工作流、检查状态
任务	监控任务状态和队列
输入	上传图像、遮罩和其他输入
输出	下载生成的内容
WebSocket	实时进度更新
对象信息	可用节点及其定义

​

后续步骤

• API 参考 - 完整的端点文档和示例
• OpenAPI 规范 - 机器可读的 API 规范