ComfyUI-Api-Demo

KO | EN

gitlite — search

#python #hacktoberfest #ai #go #golang #macos #java #windows #awesome #cli #kubernetes #awesome-list #openai #open-source

ComfyUI-Api-Demo

(★ 12)

本地调用ComfyUI示例代码

ComfyUI-Api-Demo 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ComfyUI API Demo

ComfyUI API本地调用完整演示程序,涵盖工作流导出、API调用流程、参数说明及Python代码实现。

## 📋 目录

- [功能特性](#功能特性)
- [环境要求](#环境要求)
- [项目结构](#项目结构)
- [安装步骤](#安装步骤)
- [快速开始](#快速开始)
- [配置说明](#配置说明)
- [使用指南](#使用指南)
- [API文档](#api文档)
- [常见问题](#常见问题)
- [示例](#示例)

## ✨ 功能特性

- ✅ **基础同步调用** - 最简单的API调用方式
- ✅ **WebSocket实时监听** - 获取实时进度信息
- ✅ **批量图像生成** - 支持并发批量生成
- ✅ **图像下载工具** - 自动下载生成的图像
- ✅ **统一API客户端** - 整合所有功能,简单易用
- ✅ **交互式命令行界面** - 友好的用户交互体验
- ✅ **集中配置管理** - 配置文件统一管理所有参数

## 🔧 环境要求

- Python 3.7+
- ComfyUI 服务器 (本地或远程)
- config/workflow_api.json 为从ComfyUI中导出的工作流，**每个工作流的节点不一致，需要单独根据workflow_api.json文件进行处理**！

## 📁 项目结构

```
ComfUI-Api-Demo/
├── main.py                 # 主程序入口
├── README.md              # 使用文档
├── requirements.txt       # 项目依赖
├── config/                # 配置文件目录
│   ├── __init__.py       # 配置包初始化
│   ├── config.py         # 主配置文件
│   └── workflow_api.json # 示例工作流
├── comfyui/              # ComfyUI API工具包
│   ├── __init__.py       # 包初始化
│   ├── basic_sync.py     # 基础同步调用
│   ├── websocket_client.py # WebSocket客户端
│   ├── batch_generator.py # 批量生成器
│   ├── image_downloader.py # 图像下载器
│   └── comfyui_client.py # 统一API客户端
└── generated_images/     # 默认图像输出目录(自动创建)
```

## 📦 安装步骤

### 1. 克隆或下载本项目

```bash
cd ComfUI-Api-Demo
```

### 2. 安装依赖

```bash
uv install -r requirements.txt
```

依赖包括:
- `requests>=2.31.0` - HTTP请求库
- `websocket-client>=1.6.0` - WebSocket客户端

可选依赖:
- `Pillow` - 用于生成缩略图

```bash
uv install Pillow  # 可选
```

## 🚀 快速开始

### 前提条件

1. 启动ComfyUI服务器:
```bash
# 在ComfyUI目录下运行
uv.exe run .venv/Scripts/python.exe  main.py --listen 0.0.0.0 --port 8188
```

2. 在ComfyUI WebUI中搭建工作流并导出为API格式:
   - 点击菜单栏的"工作流"
   - 选择"导出(API)"
   - 保存为 `workflow_api.json`

3. 将导出的 `workflow_api.json` 放置在 `config/` 目录下

### 运行演示

```bash
# 交互式模式 (推荐新手)
uv.exe run .venv/Scripts/python.exe  main.py

# 运行所有演示
uv.exe run .venv/Scripts/python.exe  main.py --mode demo

# 单张生成 (同步)
uv.exe run .venv/Scripts/python.exe  main.py --mode sync

# 单张生成 (WebSocket实时)
uv.exe run .venv/Scripts/python.exe  main.py --mode ws

# 批量生成
uv.exe run .venv/Scripts/python.exe  main.py --mode batch
```

## ⚙️ 配置说明

所有配置项集中在 `config/config.py` 文件中,可以根据需要修改:

```python
# ComfyUI服务器地址
SERVER_ADDRESS = "http://127.0.0.1:8188"

# 工作流JSON文件路径
WORKFLOW_FILE = "config/workflow_api.json"

# 默认图像保存目录
DEFAULT_SAVE_DIR = "./generated_images"

# 默认批量生成并发数
DEFAULT_MAX_WORKERS = 2

# 默认图像尺寸
DEFAULT_IMAGE_WIDTH = 768
DEFAULT_IMAGE_HEIGHT = 768

# 默认采样参数
DEFAULT_STEPS = 50
DEFAULT_CFG = 7.5
DEFAULT_SEED = -1

# 请求超时时间(秒)
REQUEST_TIMEOUT = 300
```

## 📖 使用指南

### 1. 基础同步调用

最简单的调用方式,直接等待结果返回:

```python
from comfyui import ComfyUISyncClient

# 创建客户端 (使用配置文件的默认值)
client = ComfyUISyncClient()

# 或自定义参数
# client = ComfyUISyncClient(
#     server_address="http://127.0.0.1:8188",
#     workflow_file="config/workflow_api.json"
# )

# 生成图像
result = client.generate_image(
    prompt_text="一只可爱的猫咪在花园里玩耍",
    width=768,
    height=768,
    seed=-1
)

print(result)
```

### 2. WebSocket实时监听

获取实时进度,适合需要显示生成过程的场景:

```python
from comfyui import ComfyUIWebSocketClient
import json

# 加载工作流
with open("config/workflow_api.json", "r") as f:
    workflow = json.load(f)

# 创建客户端 (使用配置文件的默认值)
client = ComfyUIWebSocketClient()

# 生成图像
result = client.generate_with_websocket(
    workflow=workflow,
    prompt_text="日落时分的海边风光",
    width=768,
    height=768
)
```

### 3. 批量生成

自动化批量生成多个图像:

```python
from comfyui import BatchGenerator

# 创建批量生成器 (使用配置文件的默认值)
generator = BatchGenerator()

# 定义提示词
prompts = [
    "一只可爱的柯基犬在樱花树下奔跑",
    "美丽的日落风景,金色阳光",
    "高山湖泊,倒影清晰"
]

# 批量生成
results = generator.batch_generate(
    prompts=prompts,
    width=768,
    height=768
)

print(f"成功生成: {len([r for r in results if r['success']])} 张")
```

### 4. 下载图像

将生成的图像保存到本地:

```python
from comfyui import ImageDownloader

# 创建下载器 (使用配置文件的默认值)
downloader = ImageDownloader()

# 下载单张图像
path = downloader.download_image(
    image_url="http://127.0.0.1:8188/view?filename=ComfyUI_00001.png"
)

print(f"图像已保存: {path}")
```

### 5. 统一API客户端

整合所有功能的统一接口:

```python
from comfyui import ComfyUIUnifiedClient

# 创建客户端 (使用配置文件的默认值)
client = ComfyUIUnifiedClient()

# 同步生成
result1 = client.generate(
    prompt_text="一只可爱的猫咪",
    width=768,
    height=768,
    mode="sync"
)

# WebSocket生成
result2 = client.generate(
    prompt_text="美丽的日落",
    width=768,
    height=768,
    mode="websocket"
)

# 批量生成
results = client.batch_generate(
    prompts=["提示词1", "提示词2", "提示词3"],
    width=768,
    height=768
)
```

## 📚 API文档

### ComfyUISyncClient

#### 初始化

```python
ComfyUISyncClient(server_address="http://127.0.0.1:8188", workflow_file="workflow_api.json")
```

#### 方法

##### `generate_image()`

同步生成图像

**参数:**
- `prompt_text` (str): 提示词
- `prompt_node_id` (str): 提示词节点ID,默认"91"
- `width` (int): 图像宽度
- `height` (int): 图像高度
- `latent_node_id` (str): Latent节点ID,默认"86:58"
- `seed` (int): 随机种子,-1表示随机
- `seed_node_id` (str): 种子节点ID,默认"86:3"
- `steps` (int): 采样步数
- `cfg` (float): 提示词相关性
- `sampler_name` (str): 采样器名称
- `scheduler` (str): 调度器

**返回:**
```python
{
    "prompt_id": "xxx",
    "filename": "xxx.png",
    "type": "output",
    "subfolder": "",
    "full_url": "http://..."
}
```

##### `modify_parameter()`

修改工作流参数

**参数:**
- `node_id` (str): 节点ID
- `parameter_name` (str): 参数名
- `value`: 新值

### ComfyUIWebSocketClient

#### 初始化

```python
ComfyUIWebSocketClient(server_address="127.0.0.1:8188")
```

#### 方法

##### `generate_with_websocket()`

使用WebSocket方式生成图像

**参数:**
- `workflow` (dict): 工作流JSON对象
- `prompt_text` (str): 提示词
- `prompt_node_id` (str): 提示词节点ID
- `width` (int): 图像宽度
- `height` (int): 图像高度
- `latent_node_id` (str): Latent节点ID
- `seed` (int): 随机种子
- `seed_node_id` (str): 种子节点ID

**返回:**
执行结果的字典

##### `set_progress_callback()`

设置进度回调函数

**参数:**
- `event_type` (str): 事件类型 (status, executing, progress, start, success, cached, error)
- `callback` (callable): 回调函数

### BatchGenerator

#### 初始化

```python
BatchGenerator(
    server_address="http://127.0.0.1:8188",
    workflow_file="workflow_api.json",
    max_workers=2
)
```

#### 方法

##### `batch_generate()`

批量生成图像

**参数:**
- `prompts` (list[str]): 提示词列表
- `width` (int): 图像宽度
- `height` (int): 图像高度
- `save_results` (bool): 是否保存结果到文件
- `results_file` (str): 结果文件路径

**返回:**
```python
[
    {
        "prompt": "提示词",
        "success": True,
        "prompt_id": "xxx",
        "filename": "xxx.png",
        "url": "http://..."
    },
    ...
]
```

### ImageDownloader

#### 初始化

```python
ImageDownloader(default_save_dir="./generated_images")
```

#### 方法

##### `download_image()`

下载单张图像

**参数:**
- `image_url` (str): 图像URL
- `save_path` (str): 保存目录
- `filename` (str): 保存文件名
- `overwrite` (bool): 是否覆盖已存在的文件

**返回:**
保存的文件完整路径

##### `download_batch()`

批量下载图像

**参数:**
- `urls` (list[str]): URL列表
- `save_path` (str): 保存目录
- `prefix` (str): 文件名前缀
- `overwrite` (bool): 是否覆盖

**返回:**
成功下载的文件路径列表

### ComfyUIUnifiedClient

#### 初始化

```python
ComfyUIUnifiedClient(
    server_address="http://127.0.0.1:8188",
    workflow_file="workflow_api.json",
    default_save_dir="./generated_images"
)
```

#### 方法

##### `generate()`

生成图像 (统一入口)

**参数:**
- `prompt_text` (str): 提示词
- `width` (int): 图像宽度
- `height` (int): 图像高度
- `seed` (int): 随机种子
- `steps` (int): 采样步数
- `cfg` (float): 提示词相关性
- `mode` (str): 调用模式 ("sync" 或 "websocket")
- `download` (bool): 是否自动下载图像

**返回:**
生成结果的字典

##### `batch_generate()`

批量生成图像

**参数:**
- `prompts` (list[str]): 提示词列表
- `width` (int): 图像宽度
- `height` (int): 图像高度
- `max_workers` (int): 最大并发数
- `download` (bool): 是否自动下载所有图像

**返回:**
生成结果列表

## ❓ 常见问题

### Q1: 提示词不生效怎么办?

检查节点ID是否正确。导出的JSON中,CLIPTextEncode节点的ID可能与你的不同,需要根据实际JSON调整。

**解决方法:**
1. 打开 `config/workflow_api.json`
2. 查找 `class_type` 为 `CLIPTextEncode` 的节点
3. 确认提示词对应的节点ID
4. 在代码中使用正确的节点ID

### Q2: 如何获取生成的图像文件?

**方法1:** 通过`/view`端点直接访问
```python
image_url = f"{COMFYUI_ADDRESS}/view?filename={filename}"
```

**方法2:** 使用图像下载器
```python
from comfyui import ImageDownloader
downloader = ImageDownloader()
path = downloader.download_image(image_url)
```

**方法3:** 从ComfyUI的`output`目录直接复制文件

### Q3: 批量生成速度慢怎么办?

1. **使用多线程并发请求**
   ```python
   generator = BatchGenerator(max_workers=4)
   ```

2. **优化工作流**,减少不必要的节点

3. **使用更强大的GPU**

4. **考虑使用云平台的Serverless API**,支持多实例并发

### Q4: API调用返回错误?

检查:
1. ✅ ComfyUI服务器是否正常运行
2. ✅ 工作流JSON格式是否正确
3. ✅ 节点连接关系是否完整
4. ✅ 模型文件是否存在

### Q5: 如何修改节点参数?

```python
client = ComfyUIUnifiedClient()

# 修改提示词
client.modify_workflow_parameter("91", "text", "新的提示词")

# 修改图像尺寸
client.modify_workflow_parameter("86:58", "width", 1024)
client.modify_workflow_parameter("86:58", "height", 1024)

# 修改种子
client.modify_workflow_parameter("86:3", "seed", -1)
```

### Q6: WebSocket连接失败?

1. 检查ComfyUI服务器地址 (不需要 http://)
   ```python
   # 正确
   client = ComfyUIWebSocketClient(server_address="127.0.0.1:8188")

# 错误
   client = ComfyUIWebSocketClient(server_address="http://127.0.0.1:8188")
   ```

2. 确保ComfyUI服务器正在运行

3. 检查防火墙设置

## 🎯 示例

### 示例1: 单张图像生成

```python
from comfyui_client import ComfyUIUnifiedClient

client = ComfyUIUnifiedClient()

result = client.generate(
    prompt_text="一只可爱的柯基犬在樱花树下奔跑",
    width=768,
    height=768,
    seed=-1,
    mode="sync"
)

print(f"图像URL: {result['full_url']}")
```

### 示例2: 批量生成

```python
from comfyui_client import ComfyUIUnifiedClient

client = ComfyUIUnifiedClient()

prompts = [
    "春天的花朵",
    "夏天的海滩",
    "秋天的落叶",
    "冬天的雪景"
]

results = client.batch_generate(
    prompts=prompts,
    width=768,
    height=768,
    max_workers=2
)

for result in results:
    if result['success']:
        print(f"✓ {result['prompt']}")
    else:
        print(f"✗ {result['prompt']}: {result.get('error')}")
```

### 示例3: 实时进度监控

```python
from comfyui import ComfyUIWebSocketClient, ProgressMonitor
import json

# 创建进度监控器
monitor = ProgressMonitor()

# 加载工作流
with open("config/workflow_api.json") as f:
    workflow = json.load(f)

# 创建客户端
client = ComfyUIWebSocketClient()

# 设置回调
client.set_progress_callback("on_start", monitor.on_start)
client.set_progress_callback("on_progress", monitor.on_progress)
client.set_progress_callback("on_success", monitor.on_success)

# 生成图像
result = client.generate_with_websocket(
    workflow=workflow,
    prompt_text="美丽的风景"
)
```

### 示例4: 从文件批量生成

```python
from comfyui import BatchGenerator

# 创建提示词文件 prompts.txt
# 每行一个提示词

generator = BatchGenerator()

results = generator.generate_from_file(
    prompts_file="prompts.txt",
    width=768,
    height=768
)
```

### 示例5: 自动下载并组织图像

```python
from comfyui import ComfyUIUnifiedClient, ImageDownloader

client = ComfyUIUnifiedClient()
downloader = ImageDownloader()

# 批量生成
prompts = ["柯基犬", "日落", "风景"]
results = client.batch_generate(prompts)

# 按提示词组织下载
prompt_to_path = downloader.organize_by_prompt(results)

for prompt, path in prompt_to_path.items():
    print(f"{prompt} -> {path}")
```

## 📝 工作流JSON文件说明

导出的 `config/workflow_api.json` 文件是一个字典,键为节点ID,值为节点配置:

```json
{
  "91": {
    "inputs": {
      "value": "提示词写在这"
    },
    "class_type": "PrimitiveStringMultiline",
    "_meta": {
      "title": "Prompt"
    }
  },
  "86:3": {
    "inputs": {
      "seed": 4,
      "steps": 50,
      "cfg": 4,
      ...
    },
    "class_type": "KSampler",
    "_meta": {
      "title": "K采样器"
    }
  }
}
```

### 常见需要修改的参数

| 节点类型 | 参数名 | 说明 | 修改建议 |
|---------|--------|------|---------|
| KSampler | `seed` | 随机种子 | 设置为-1可自动生成随机数 |
| KSampler | `steps` | 采样步数 | 通常20-50 |
| KSampler | `cfg` | 提示词相关性 | 通常7-12 |
| CLIPTextEncode | `text` | 提示词 | 修改为你要生成的图像描述 |
| EmptySD3LatentImage | `width` | 图像宽度 | 根据需求调整 |
| EmptySD3LatentImage | `height` | 图像高度 | 根据需求调整 |

## 🤝 贡献

欢迎提交 Issue 和 Pull Request!

## 📄 许可证

本项目遵循 MIT 许可证。

## 🔗 相关链接

- [ComfyUI官方GitHub](https://github.com/comfyanonymous/ComfyUI)
- [ComfyUI文档](https://docs.comfyanonymous.github.io/ComfyUI/)
- [ComfyUI API调用指南](./ComfyUI%20API调用指南.md)

---

**祝你使用愉快! 🎉**

ComfyUI-Api-Demo

ComfyUI-Api-Demo 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

ComfyUI-Api-Demo

ComfyUI-Api-Demo 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README