ComfyUI API 教程：深入解析与应用

ComfyUI API 是现代图像生成领域中的一个革命性工具，它为开发者提供了一个功能全面、灵活易用的接口来进行图像生成任务。本文将详细探讨 ComfyUI API 的使用方法、与传统 WebUI API 的对比、API 调用的详细步骤以及如何在实际项目中有效应用这一工具。

为什么选择 ComfyUI API？

ComfyUI API 在图像生成领域中以其卓越的性能和便捷的使用方式受到广泛关注。与传统的 WebUI API 相比，ComfyUI API 提供了一系列显著的优势，使其成为开发者的首选。

自带队列管理

ComfyUI API 自带队列管理功能，这意味着开发者无需担心任务的排列和调度。传统的 WebUI API 通常需要开发者自行管理任务队列，这可能导致资源浪费和任务冲突。ComfyUI API 的内置队列功能自动处理任务的排队和执行，确保系统的高效运行。

支持 WebSocket

WebSocket 是一种全双工的通信协议，允许客户端和服务器之间进行实时数据传输。ComfyUI API 支持 WebSocket，使得开发者能够实时获取任务执行进度和结果。这一功能在需要快速响应和实时显示结果的应用场景中尤为重要。

无需关心插件接口

使用 ComfyUI API，开发者无需关心插件是否开放 API 接口。只要插件在浏览器中正常使用，ComfyUI API 就能无缝集成和使用。这大大简化了开发人员的工作流程，使他们可以专注于核心功能的开发，而不必花费时间在插件接口的研究上。

模型切换与进度查询

ComfyUI API 提供了便捷的模型切换和进度查询功能。开发者可以轻松切换不同的模型，以适应不同的任务需求。同时，通过 API 提供的进度查询接口，开发者可以随时了解当前任务的执行状态，便于调整和优化。

支持任务中断

在复杂的图像生成任务中，有时需要中断当前任务以处理更高优先级的任务。ComfyUI API 支持任务中断功能，使开发者能够灵活管理任务的优先级，确保关键任务能够及时完成。

免除繁琐的 Base64 转换

在图像处理过程中，传统方法通常需要将图像数据转换为 Base64 格式进行传输，这一过程既繁琐又耗时。ComfyUI API 直接支持图像数据的传输和处理，省去了这一复杂步骤，提高了数据处理效率。

ComfyUI API 的接口详解

ComfyUI API 提供了一系列功能强大的接口，支持多种图像生成任务。以下是对这些接口的详细介绍。

绘图接口：POST /prompt

ComfyUI API 的绘图接口负责接收图像生成任务并返回任务 ID。与传统的 WebUI API 不同，ComfyUI API 并没有单独区分文本生成图像、图像生成图像的接口。所有的绘图任务都使用 POST /prompt 接口，通过参数来定义具体任务。

请求参数

client_id: 用于标记任务发起者的 ID。由客户端生成，是必需参数。
prompt: 任务参数，通常是一个 JSON 数据，包含生成图像的各种设置，如提示词、模型、图片尺寸等。

返回参数

prompt_id: 返回任务的唯一标识符。
number: 当前任务序号，用于后续计算需要等待的任务数。
node_errors: 错误信息，若有。

使用说明

在使用 POST /prompt 接口时，开发者需要确保上传的参数准确无误。任务 ID 是由客户端生成的，标记该任务的发起者。ComfyUI API 会通过 WebSocket 将属于该任务的绘图信息推送给发起者。

WebSocket 接口：/ws?clientId=XXXXXXXX

WebSocket 接口用于实时推送任务进度和结果。开发者只需监听 WebSocket 消息，无需发送任何消息给 ComfyUI。

文本数据详解

任务变更通知：当任务队列发生变更时，ComfyUI 会发送 status 类型的信息，通知当前任务数的变化。
任务开始执行：当任务开始执行时，会发送 execution_start 类型的信息，通知任务 ID。
任务执行步骤：在任务执行过程中，会发送 executing 类型的信息，通知当前执行的步骤。
进度信息：通过 progress 类型的信息，通知当前步骤的进度。
绘图结束：当绘图任务结束时，仍然会发送 executing 类型的信息，但 node 为 null，表示流程结束。

图片的在线预览接口：GET /view

图片的在线预览接口用于获取生成的图像。通过传递图片名称和存放位置，可以获取到图像的 URL 访问地址。

请求参数

filename: 图片名称。
type: 图片存放位置的文件夹。
subfolder: 子文件夹（可选）。
preview: 预览选项（可选）。

二进制数据详解

如果在采样器中开启了图片预览，ComfyUI 会以二进制数据的方式推送图片预览信息。这一功能使得开发者能够在图像生成过程中实时查看生成效果。

生产部署与应用

在生产环境中使用 ComfyUI API，开发者可以通过编写脚本或集成到现有系统中来实现高效的图像生成。

本地化运行脚本编写

开发者可以编写脚本来实现 ComfyUI API 的调用和结果处理。以下是一个简单的示例：

import json
import websocket
import uuid
import urllib.request
import urllib.parse

def show_gif(fname):
    import base64
    from IPython import display
    with open(fname, 'rb') as fd:
        b64 = base64.b64encode(fd.read()).decode('ascii')
    return display.HTML(f'')

def queue_prompt(textPrompt):
    p = {"prompt": textPrompt, "client_id": client_id}
    data = json.dumps(p).encode('utf-8')
    req = urllib.request.Request("http://{}/prompt".format(server_address), data=data)
    return json.loads(urllib.request.urlopen(req).read())

def get_image(fileName, subFolder, folder_type):
    data = {"filename": fileName, "subfolder": subFolder, "type": folder_type}
    url_values = urllib.parse.urlencode(data)
    with urllib.request.urlopen("http://{}/view?{}".format(server_address, url_values)) as response:
        return response.read()

生产部署

在生产环境中，开发者可以使用 Flask 或 FastAPI 等框架来部署 ComfyUI API。通过创建一个新的 Python 脚本，集成 ComfyUI 的模块和方法，即可实现高效的图像生成服务。

结论

ComfyUI API 是一个功能强大且灵活的图像生成工具。它不仅解决了传统 WebUI API 的诸多问题，还为开发者提供了一种高效、便捷的图像生成方式。在实际应用中，ComfyUI API 可以显著提高开发效率和图像生成质量，是开发者不可或缺的工具。

FAQ

问：ComfyUI API 支持哪些图像生成任务？
- 答：ComfyUI API 支持文本生成图像、图像生成图像、换脸、倒推关键词等多种图像生成任务。
问：如何集成 ComfyUI API 到现有项目中？
- 答：开发者可以通过编写脚本或使用 Web 框架（如 Flask、FastAPI）来集成 ComfyUI API。确保正确配置 API 接口和参数，即可实现无缝集成。
问：ComfyUI API 的 WebSocket 功能如何使用？
- 答：开发者只需监听 WebSocket 消息，无需发送消息给 ComfyUI。通过 WebSocket，开发者可以实时获取任务进度和结果。
问：ComfyUI API 如何处理任务队列？
- 答：ComfyUI API 自带队列管理功能，自动处理任务的排队和执行，无需开发者干预。
问：在图像生成过程中如何获取预览？
- 答：开发者可以在采样器中开启图片预览，ComfyUI 会以二进制数据的方式推送图片预览信息，便于实时查看生成效果。