Start here: the Comfy SDKs
For a new integration, use the official Comfy SDKs (Python and TypeScript) and the Comfy API v2 they call. The same code runs against every deployment target; only the base URL changes.Comfy SDKs
Install the SDK, submit a workflow, and download the outputs. Currently in beta.
What works against what
Self-hosted instances can also skip the SDK entirely and use the raw ComfyUI Server API (REST + WebSocket). It exposes the full local surface, including the queue and node info, but has no compatibility guarantee across releases.
Which API should I use?
All of them accept the same workflow format (API format), so you can develop and test workflows locally and move them to another deployment without changes.
Getting started
Comfy SDKs
Run workflows from Python or TypeScript, against any deployment target.
API Proxy for Self-Hosted
Serve the v2 API in front of your own ComfyUI so the SDKs can reach it.
Workflow API Format
Export workflows in the JSON format the APIs accept.
ComfyUI Server API
The raw REST and WebSocket API of a self-hosted instance.
Prerequisites
- An API key for anything that touches Comfy Cloud, a Serverless deployment, or Partner Nodes. A purely local ComfyUI does not need one.
- A workflow exported in API format.