ComfyUI的API使用教程

最新推荐文章于 2025-02-23 16:58:27 发布
最新推荐文章于 2025-02-23 16:58:27 发布
阅读量4.5k 收藏 42
点赞数 10
分类专栏： AIGC 文章标签： python 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/benben044/article/details/145036332
版权

ComfyUI的api接口文档：comfyui-api.md · YY/wailikeji-chatgpt - Gitee.com

1、调用API的使用流程

1）用户设计好工作流

2）将工作流保存为API形式的json内容

3）调用ComfyUI的API，输入json内容作为prompts参数传入，得到最终结果

2、绘图接口：POST/prompt

注意：该接口只做绘图任务的下发，然后返回任务ID信息。并不会直接返回最终的结果图！

与webui的api不同的是，comfyui的api并没有单独区分文生图、图生图的接口，而是所有的绘图任务的下发全部都使用POST /prompt。那具体是文生图、图生图、又或者是换脸、倒推关键词等，取决于你的参数！

需要上传的参数只有两个请求参数：

名称类型必选说明
client_idstring是任务ID,由客户端生成，用于标记任务是谁发起的
promptjson是任务参数

返回参数：

名称类型说明
prompt_idstring任务ID
numberint当前任务序号，可用于后续获取需要等待任务数的计算
node_errorsjson错误信息

返回示例：

{
    "prompt_id": "bd2cfa2c-de87-4258-89cc-d8791bc13a61",
    "number": 501,
    "node_errors": {}
}

使用说明：

clientId：任务ID,由客户端生成，用于标记任务是谁发起的,相当于告诉comfyui，该绘图任务是由用户A发起的，后续comfyui就会通过websocket将属于用户A的绘图信息推送给你。

3、websocket：/ws?clientId=XXXXXXXX

client_id后面的参数即为上面/prompt接口中上传给comfyui的client_id，假如没有上传client_id，那comfyui就不知道连上该websocket的用户是谁，也就无法进行信息推送！comfyui拿到client_id后，即可知道当前是哪个用户，后续就会通过websocket将属于该用户的绘图信息精准推送给他。

注意：websocket只需做监听处理，无需通过websocket向comfyui发送任何消息。

websocket数据解析：
主要有两种数据格式：
1、文本数据，文本数据主要通知以下几个绘图信息：
通知任务变更、当前执行的步骤、进度
2、二进制数据，即图片预览信息

（1）任务变更通知

{
    "type":"status",
    "data":{
        "status":{
            "exec_info":{
                "queue_remaining":7
            }
        }
    }
}

当你收到type为status信息时，这是comfyui在告诉你，当前任务数发生变更，queue_remaining是指当前还有多少个任务需要处理。

注意，此处的queue_remaining并不是告诉你在你的任务之前还有多少个任务需要处理！而是总的！

所以，当还没轮到你的绘图任务时，显示还需等待多少个任务，你就需要借助comfyui的另一个接口：GET /queue：获取详细任务队列信息，正在运行的以及挂起的。该接口会返回挂起的任务信息，其中有prompt_id信息和number信息，你可以根据这number信息获取到当前任务排在第几位。

（2）当前任务开始执行

{
    "type":"execution_start",
    "data":{
        "prompt_id":"3935f7c3-ec38-4d94-843f-86fe86c6d384"
    }
}

当你收到type为execution_start信息时，这是comfyui在告诉你，你的任务id，prompt_id为“3935f7c3-ec38-4d94-843f-86fe86c6d384”的任务当前正在被执行

（3）当前任务执行的步骤信息

{
    "type":"executing",
    "data":{
        "node":"5",
        "prompt_id":"3935f7c3-ec38-4d94-843f-86fe86c6d384"
    }
}

当你收到type为executing信息时，这是comfyui在告诉你，你的任务id，prompt_id为“3935f7c3-ec38-4d94-843f-86fe86c6d384”的任务当前正在执行节点5的步骤。

（4）当前进度信息

{
    "type":"progress",
    "data":{
        "value":1,
        "max":10
    }
}

当你收到type为progress信息时，这是comfyui在告诉你，当前步骤执行的进度，value是当前的步数，max是总的步数。

（5）绘图结束

{
    "type":"executing",
    "data":{
        "node":null,
        "prompt_id":"37099310-a790-44f4-8d13-4f4d5f69c891"
    }
}

绘图结束时，type类型仍然是executing，和前面的（3）是一样的，区别主要在于node为null,也就是当type=executing,且node=null的时候，说明流程已经跑完，此时需要通过接口GET /history/{prompt_id}获取输出的图片信息。底下是通过history获取到的图片信息。

{
    "37099310-a790-44f4-8d13-4f4d5f69c891": {
    	略。。。。。。。。。。
        "outputs": {
            "18": {
                "images": [
                    {
                        "filename": "ComfyUI_temp_slqio_00001_.png",
                        "subfolder": "",
                        "type": "temp"
                    },
                    {
                        "filename": "ComfyUI_temp_slqio_00002_.png",
                        "subfolder": "",
                        "type": "temp"
                    },
                    {
                        "filename": "ComfyUI_temp_slqio_00003_.png",
                        "subfolder": "",
                        "type": "temp"
                    },
                    {
                        "filename": "ComfyUI_temp_slqio_00004_.png",
                        "subfolder": "",
                        "type": "temp"
                    }
                ]
            },
            "22": {
                "images": [
                    {
                        "filename": "ComfyUI_temp_rfvdr_00001_.png",
                        "subfolder": "",
                        "type": "temp"
                    },
                    {
                        "filename": "ComfyUI_temp_rfvdr_00002_.png",
                        "subfolder": "",
                        "type": "temp"
                    },
                    {
                        "filename": "ComfyUI_temp_rfvdr_00003_.png",
                        "subfolder": "",
                        "type": "temp"
                    },
                    {
                        "filename": "ComfyUI_temp_rfvdr_00004_.png",
                        "subfolder": "",
                        "type": "temp"
                    }
                ]
            },
            "24": {
                "images": [
                    {
                        "filename": "ComfyUI_00702_.png",
                        "subfolder": "",
                        "type": "output"
                    },
                    {
                        "filename": "ComfyUI_00703_.png",
                        "subfolder": "",
                        "type": "output"
                    },
                    {
                        "filename": "ComfyUI_00704_.png",
                        "subfolder": "",
                        "type": "output"
                    },
                    {
                        "filename": "ComfyUI_00705_.png",
                        "subfolder": "",
                        "type": "output"
                    }
                ]
            }
        }
    }
}

outputs中的内容就是最终生成的图片信息。

4、基于python的代码实战

按照websocket库：pip install websocket-client

import websocket
import uuid
import json
import urllib.request
import urllib.parse
from PIL import Image
import io

# 设置服务器地址和客户端
server_address = "127.0.0.1:18188"
client_id = str(uuid.uuid4())


# 定义向服务器发送提示的函数
def queue_prompt(prompt):
    p = {"prompt": prompt, "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()


# 定义获取历史记录的函数
def get_history(prompt_id):
    with urllib.request.urlopen("http://{}/history/{}".format(server_address, prompt_id)) as response:
        return json.loads(response.read())


# 定义通过WebSocket接收消息并下载图像的函数
def get_images(ws, prompt):
    prompt_id = queue_prompt(prompt)['prompt_id']
    output_images = {}
    while True:
        out = ws.recv()
        if isinstance(out, str):
            message = json.loads(out)
            if message['type'] == 'executing':
                data = message['data']
                if data['node'] is None and data['prompt_id'] == prompt_id:
                    break  # 执行完成
        else:
            continue  # 预览是二进制数据

    history = get_history(prompt_id)[prompt_id]
    for o in history['outputs']:
        for node_id in history['outputs']:
            node_output = history['outputs'][node_id]
            if 'images' in node_output:
                images_output = []
                for image in node_output['images']:
                    image_data = get_image(image['filename'], image['subfolder'], image['type'])
                    images_output.append(image_data)
            output_images[node_id] = images_output

    return output_images

# 示例JSON字符串，表示要使用的提示
prompt_text = """
{
  "1": {
    "inputs": {
      "ckpt_name": "realcartoonXL_v5.safetensors"
    },
    "class_type": "CheckpointLoaderSimple",
    "_meta": {
      "title": "加载检查点"
    }
  },
  "2": {
    "inputs": {
      "lora_name": "t_realcartoon.safetensors",
      "strength_model": 0.7000000000000001,
      "strength_clip": 0.7000000000000001,
      "model": [
        "1",
        0
      ],
      "clip": [
        "1",
        1
      ]
    },
    "class_type": "LoraLoader",
    "_meta": {
      "title": "加载LoRA"
    }
  },
  "3": {
    "inputs": {
      "seed": 152656324223018,
      "steps": 20,
      "cfg": 8,
      "sampler_name": "euler",
      "scheduler": "normal",
      "denoise": 1,
      "model": [
        "2",
        0
      ],
      "positive": [
        "8",
        0
      ],
      "negative": [
        "9",
        0
      ],
      "latent_image": [
        "6",
        0
      ]
    },
    "class_type": "KSampler",
    "_meta": {
      "title": "K采样器"
    }
  },
  "4": {
    "inputs": {
      "samples": [
        "3",
        0
      ],
      "vae": [
        "1",
        2
      ]
    },
    "class_type": "VAEDecode",
    "_meta": {
      "title": "VAE解码"
    }
  },
  "5": {
    "inputs": {
      "filename_prefix": "ComfyUI",
      "images": [
        "4",
        0
      ]
    },
    "class_type": "SaveImage",
    "_meta": {
      "title": "保存图像"
    }
  },
  "6": {
    "inputs": {
      "width": 512,
      "height": 512,
      "batch_size": 1
    },
    "class_type": "EmptyLatentImage",
    "_meta": {
      "title": "空潜空间图像"
    }
  },
  "7": {
    "inputs": {
      "stop_at_clip_layer": -2,
      "clip": [
        "2",
        1
      ]
    },
    "class_type": "CLIPSetLastLayer",
    "_meta": {
      "title": "设置CLIP最后一层"
    }
  },
  "8": {
    "inputs": {
      "text": "t<lora:t_realcartoon:1> Running beside the beach",
      "clip": [
        "7",
        0
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP文本编码（提示）"
    }
  },
  "9": {
    "inputs": {
      "text": "",
      "clip": [
        "7",
        0
      ]
    },
    "class_type": "CLIPTextEncode",
    "_meta": {
      "title": "CLIP文本编码（提示）"
    }
  }
}

"""

# 将示例JSON字符串解析为Python字典，并根据需要修改其中的文本提示和种子值
prompt = json.loads(prompt_text)
prompt["8"]["inputs"]["text"] = "t<lora:t_realcartoon:1> Running beside the beach"
prompt["3"]["inputs"]["seed"] = 1

# 创建一个WebSocket连接到服务器
ws = websocket.WebSocket()
ws.connect("ws://{}/ws?clientId={}".format(server_address, client_id))

# 调用get_images()函数来获取图像
images = get_images(ws, prompt)

# 显示图片
for node_id in images:
    for image_data in images[node_id]:
        image = Image.open(io.BytesIO(image_data))
        image.show()
        input("")

本文参考：

stable diffusion comfyui的api使用教程_comfyui api-CSDN博客

ComfiUI API调用随记_comfyui api-CSDN博客

comfyui api
liguandong
03-28 2120
stable diffusion comfyui的api使用教程，为什么要使用comfyui的api？comfyui的api设计，其中comfyui-api写的不错的，用的还是websocket，cog-comfyui可以同时把comfyui启起来。stable diffusion comfyui的api使用教程_厦门外里科技的技术博客_51CTO博客。comfyui api接口文档_51CTO博客_api接口文档怎么用。comfyui api接口文档，comfyuiapi接口文档。
DeepSeek开源多模态模型Janus-Pro的ComfyUI使用教程
wjianwei666的专栏
02-07 615
这个工作流节点包含了图像描述和图像生成。
C# 调用ComfyUI 接口小案例，可以生成任务，可以获取图片，可以显示图片
05-15
一定要生成 api.json api.json api.json 一定要生成 api.json api.json api.json 一定要生成 api.json api.json api.json 1.需要把图片上传到ComfyUI Input文件夹中，拿到图片在服务器中的物理地址，替换到api.Json 中。如果失败，新创建个文件夹，把图片上传到新文件夹和Input里面 图片名字一定要一致 2.此Dome没有用监听，是前端每隔一段时间清求一次获取图片列表的接口，根据需求情况而定 3. 设置外网访问： com ----Ipconfig 获取服务器IP地址。 找到软件目录找到run_nvidia_gpu.bat这个文件。 右键，点击编辑，或者用其他文本编辑器打开。 打开之后，在最后加上参数 --listen+IP地址 --listen 192.168.31.214
ComfiUI API调用随记
applebomb的专栏
12-01 1万+
来进行知识接力了：首先了解下ComfiUI的API对于ComfiUI，接口比较简单。查询接口比较容易看明白。对于发起prompt的请求，如果需要图片的，则需预先上传图片给ComfiUI，获取返回的文件名进行调用。发起调用后，实际上是加入队列，获得一个任务ID，通过ws实时获取对应的执行状态，进度等数据。当未执行时，则查询任务获得图片。
ComfyUI API 文档 调用例子
最新发布
superjianshang的博客
02-23 983
图片的在线预览接口（上传图像，生图图像，蒙蔽图像，均通过该接口预览）上传图片到ComfyUI服务器的input目录。获取详细任务队列信息，正在运行的以及挂起的。上传蒙版图片接口，一般用于局部重绘。获取服务器当前剩余任务列队的数量。获取embeddings列表。取消当前任务/不需任何参数。获取所有历史任务数据。获取扩展节点文件列表。
ComfyUI 使用全攻略系列：API简介
2401_84760719的博客
01-07 3293
现在comfyUI的插件越来越多、功能越来越丰富，我们能够使用这些插件构建愈发强大的解决各种场景的工作流。而对于工作流也是我们个人的心血结晶，那么有没有什么办法能够让广大用户都能用上我们的工作流呢？下面，我们先一起来研究一下它的API获取工作流1.开启DEV模式在comfyUI功能栏上点击小齿轮，在弹出的页面中开启DEV模式，如下：开启开发者模式后，右侧功能栏中才会显示"保存(API)格式"按钮；2.获取工作流。
API调用comfyui工作流，做一个自己的app，chatgpt给我写的前端，一键创建自己的卡通形象，附源码
2401_84760527的博客
10-12 5201
工具介绍首先 comfyui你是少不了的，这个是工作流的后端支持，用这个去调试工作流和生成API可调用文件前端我们就用很流行的gradio吧，什么你一时半会没有学gradio的计划，没事，笔者也没系统学过，我干脆直接让chatgpt写前端gradio了，哈哈~
【ComfyUI的API接口调用示例】
热门推荐
.NET学习
07-10 1万+
本文调用接口示例主要指导需要调用ComfyUI的开发者如何调用ComfyUI官方的API接口提交任务、查询历史、获取绘画视频结果等。阅读本文的前提是你本地已经安装了ComfyUI，并且对工作流绘画和生成视频已经有所了解。
【ComfyUI】python调用生图API，实现批量出图
进一寸有一寸的欢喜
01-23 2234
官方给的示例：https://github.com/comfyanonymous/ComfyUI/blob/master/script_examples/websockets_api_example.pyhttps://github.com/comfyanonymous/ComfyUI/blob/master/script_examples/websockets_api_example.pyhttps://github.com/comfyanonymous/ComfyUI/blob/master/scrip
Stable Cascade | ComfyUI API 工作流格式优化
旭的博客
04-19 4734
目前，ComfyUI 是运行 Stable Cascade 模型的首选。ComfyUI 可直接保存生图工作流为 API 格式，但该 API 格式文本行数较多且节点顺序与逻辑执行顺序不一致，不利于编写或修改 API 的调用代码。本文主要介绍ComfyUI 工作流（API 格式）的结构与格式优化。
stable diffusion comfyui的api使用教程_comfyui api
月流霜的专栏
08-22 528
至此，stable diffusion comfyui的api的整个调用逻辑已经走完，无论是文生图、图生图、换脸、倒推关键词等，都是走相同的流程。
comfyui api接口文档
向来缘浅，奈何情深
11-13 1万+
comfyui api接口文档
comfyui 的 api
01-30
### ComfyUI API 文档与使用教程 #### 调用API的使用流程 为了有效利用ComfyUI的功能，理解其API调用流程至关重要。具体来说，在准备阶段需先确认环境配置无误并获取必要的访问凭证。之后通过发送HTTP请求来触发...
微信群接入ComfyUI
fanfanfan的博客
08-07 577
其实整体流程比较简单，我们封装了ComfyUI的调用流程，对项目整体侵入性较小，只需稍微改动main.pyrobot.py即可。其实，之前接入sd-webui的流程我们也可以去做一个封装，这样之后接入其他文生图项目后会显得代码更加的整洁，同时扩展性也更好，总之就是要讲究一个功能上高内聚，其他模块之间要低耦合！
FLUX.1与ComfyUI部署使用指南
2401_85116933的博客
09-30 1065
FLUX相关的模型、工作流以及全套的AI绘画学习资料已经给各位小伙伴打包好了，有需要的可以扫码自取，无偿分享。感兴趣的小伙伴，赠送全套AIGC学习资料，包含AI绘画、AI人工智能等前沿科技教程和软件工具，具体看这里。AIGC技术的未来发展前景广阔，随着人工智能技术的不断发展，AIGC技术也将不断提高。未来，AIGC技术将在游戏和计算领域得到更广泛的应用，使游戏和计算系统具有更高效、更智能、更灵活的特性。同时，AIGC技术也将与人工智能技术紧密结合，在更多的领域得到广泛应用，对程序员来说影响至关重要。
零门槛AI 绘图：教你为客户定制 ComfyUI Serverless API 应用
Serverless 社区
07-31 755
开启 Agent 能力，需要增加环境变量USE_AGENT1当通过 Agent 的 API 调用时，建议您调整单实例并发度为 1 ～ 5，确保并发请求尽量使用单独的实例，提高出图效率。
【教程】一键将ComfyUI工作流API封装为应用！教会你本地私有化部署解决方案，ComfyUI工作流商用落地变现的绝佳选择
Dream11q的博客
01-09 2012
无需开发，利用工作流搭建自己专属的AIGC网站！适用于AIGC创业项目，设计、摄影，还可以通过API提供的AI能力快速开发自己的小程序和APP！
ComfyUI web API 接口 python 调用工具 简单实现
weixin_39286961的博客
01-23 528
通过python 程序调用comfyUI workflow 生成图片 批量替换workflow 中的prompt 节点, 批量生成图片.
推荐开源项目：ComfyUI-Qwen-VL-API - 舒适的UI与强大的语义理解API
gitblog_00002的博客
04-07 930
推荐开源项目：ComfyUI-Qwen-VL-API - 舒适的UI与强大的语义理解API 项目地址:https://gitcode.com/gh_mirrors/co/ComfyUI-Qwen-VL-API 项目简介 是一个结合了优美用户界面（UI）和先进自然语言处理能力的开放源代码项目。它提供了一个易于使用的API，用于交互式问答、语义理解和多模态任务，旨在为开发者提供强大而便捷的工具，帮助他...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值