Back to Skills

comfyui-api

Connect to a running ComfyUI instance, queue workflows, monitor execution, and retrieve results. Supports both online (REST API) and offline (JSON export) modes. Use when executing ComfyUI workflows or checking server status.

86stars24forksUpdated 8/14/2026

Security Assessment

Safe(92/100)
Security Score92/100

About comfyui-api

This skill teaches an agent how to talk to a running ComfyUI instance over its REST API so that image and video generation workflows can be queued, monitored, and collected without leaving the assistant. It solves the practical gap between having a ComfyUI node graph and actually executing it: connecting to the server (default `http://127.0.0.1:8188`), queuing a workflow, waiting for it to finish, and pulling the resulting files back down. It also defines an offline fallback that exports workflow JSON to disk for manual drag-and-drop loading when no server is available.

The documented operations are all standard ComfyUI HTTP endpoints driven with curl: check server status via `GET /system_stats`, submit a workflow with `POST /prompt`, poll `GET /history/{prompt_id}` every five seconds for completion, download outputs from `GET /view`, upload reference images to `POST /upload/image`, interrupt the current run, and free VRAM. It includes a polling strategy with a 10-minute warning threshold (video generation can take much longer), a workflow validation step that cross-checks node class_types and model filenames against a cached inventory, and an error-handling table mapping connection refusals and HTTP errors to remediation steps.

It is aimed at people building ComfyUI automation, generative-media agents, or batch pipelines who want a reliable programmatic bridge to their own local or self-hosted ComfyUI server. It is part of a larger "comfyui-expert" skill set and defers to sibling skills (comfyui-inventory, comfyui-troubleshooter) for discovery and error diagnosis.

FAQ

What ComfyUI server does it connect to?

By default `http://127.0.0.1:8188`. A custom URL can be set in the project manifest, passed as a parameter, or supplied via the COMFYUI_URL environment variable.

What if ComfyUI is not running?

It switches to offline mode, generating the workflow JSON and saving it under the project's workflows directory so the user can drag-and-drop it into ComfyUI manually.

How does it know when a generation is finished?

It polls `GET /history/{prompt_id}` every five seconds; an empty response means still in progress, a populated response with status.completed true means done. It warns the user after 10 minutes since large video jobs can take 15-30 minutes.

What tools are required?

The metadata lists curl or wget as required binaries, and it works on macOS, Linux, and Windows.

Does it install models or nodes?

No. It validates workflows against an inventory and flags missing nodes or models with install/download suggestions, but installation is out of scope and delegated to other skills.

Install comfyui-api

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill