全网最详细的ComfyUI API介绍
鉴于全网都找不到ComfyUI服务的API详细介绍,发现有部分博主写了,但是感觉不全面,因此,笔者阅读了ComfyUI的源码,整理了ComfyUI服务的API接口及调用方法。目的是帮助和我一样基于ComfyUI搭建AI应用的朋友。
1. 获取扩展列表
- API: GET /extensions
- 调用方式:http://localhost:8000/extensions
- 返回信息:扩展列表
2. 获取模型类型列表
API: GET /models
调用方式:http://localhost:8000/models
返回信息:模型列表
3. 获取embedding列表
API:GET /embeddings
调用方式:http://localhost:8000/embeddings
返回信息:embeddings列表
4. 获取{folder}目录下的模型列表
API:GET /models/{folder}
调用方式:http://localhost:8000/models/vae
返回信息:{folder}目录下的模型列表
调用方式:http://localhost:8000/models/loras
返回信息:{folder}目录下的模型列表
5. 上传图片
API:POST /upload/image
调用方式:http://localhost:8000/upload/image
返回信息:
6. 图片预览(下载)
API:GET /view
参数:
- filename:文件名
- subfolder:文件所在的子目录
- type:input / output
- preview:webp / jpeg;quality。quality最大值100。如果忽略该参数,则返回png格式
调用方式:
返回结果:
7. 获取模型元数据
API:GET /view_metadata/{folder_name}
参数:
- filename:模型名称
调用方式:http://localhost:8000/view_metadata/vae?filename=ae.safetensors
返回结果:
8. 获取系统信息
API:GET /system_stats
调用方式:http://localhost:8000/system_stats
返回信息:
9. 获取服务特征
API:GET /features
调用方式:http://localhost:8000/features
返回结果:
{
"supports_preview_metadata": true,
"max_upload_size": 104857600
}
10. 获取当前剩余任务列队的数量
API:GET /prompt
调用方式:http://localhost:8000/prompt
返回结果:
{
"exec_info": {
"queue_remaining": 0
}
}
11. 绘图任务的下发
API:POST /prompt
调用方式:http://localhost:8000/prompt
返回结果:
{
"prompt_id": "20e4f747-a208-42a5-897c-03749ccfcd03",
"number": 35,
"node_errors": {}
}
12. 获取节点信息
API:GET /object_info
调用方式:http://localhost:8000/object_info
返回结果:所有节点描述信息
13. 获取特定节点信息
API:GET /object_info/{node_class}
调用方式:
http://localhost:8000/object_info/KSampler
http://localhost:8000/object_info/CLIPTextEncode
返回结果:
14. 获取运行和等待的队列信息
API: GET /queue
调用方式:http://localhost:8000/queue
返回结果:运行队列和等待队列列表
15. 清除等待队列中的任务
API:POST /queue
调用方式:http://localhost:8000/queue
返回结果:正确则返回200
16. 删除等待队列中的特定任务
API:POST /queue
调用方式:
返回结果:正确返回200
17. 取消当前任务
API:POST /interrupt
调用方式:http://localhost:8000/interrupt
返回结果:正确返回200
18. 获取历史生成信息
API:GET /history
调用方式:http://localhost:8000/history
返回结果:历史任务列表
19. 获取特定prompt_id的历史信息
API:GET /history/{prompt_id}
调用方式:
返回结果:
20. 清除所有历史记录(生成结果会保留)
API:POST /history
调用方式:
返回结果:执行正确返回200
21. 清除特定任务的历史记录
API: POST /history
调用方式:
返回结果:执行正确返回200
由于时间关系,部分内容可能不够详细,如果大家遇到问题可以在评论区讨论,笔者会第一时间帮大家解答。
如果觉得内容对您有帮助,不如一键三连。
更多推荐
所有评论(0)