comfyui_openapi
REST API for interacting with a ComfyUI server. **Note:** ComfyUI also exposes a WebSocket endpoint at `ws://{host}/ws` for real-time execution updates (progress, node status, errors). WebSocket messages are not representable in OpenAPI — see the original documentation for details. Sources: [ComfyUI GitHub](https://github.com/comfyanonymous/ComfyUI) | [docs.comfy.org](https://docs.comfy.org/essentials/comms_routes)
Connect this API to an AI agent Browse all specs
What you can do with comfyui_openapi via MCP
Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.
| Method | Path | Operation | Description |
|---|---|---|---|
| POST | /prompt |
postPrompt | Submit a workflow for execution |
| GET | /queue |
getQueue | Get current queue status |
| GET | /history |
getHistory | Get execution history |
| GET | /history/{prompt_id} |
getHistoryByPromptId | Get a specific execution record |
| GET | /view |
getView | View / download a generated image |
| POST | /upload/image |
postUploadImage | Upload an input image |
| POST | /upload/mask |
postUploadMask | Upload a mask image |
| GET | /object_info |
getObjectInfo | Get all available node types and their schemas |
| GET | /system_stats |
getSystemStats | Get system resource statistics |
| GET | /extensions |
getExtensions | List installed extensions |
| POST | /interrupt |
postInterrupt | Interrupt current execution |
Usage guide
change your base url
How to use this spec
- Create a free VX Agents account (sandbox tools included).
- Open the marketplace and connect “comfyui_openapi” to an agent.
- Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.