Skip to main content
Deprecated: The v1 Cloud API is deprecated in favor of Comfy API v2. It remains available for existing integrations and for Cloud capabilities v2 does not expose yet, but endpoints and behavior may change without notice.
The v1 Cloud API provides programmatic access to Comfy Cloud, Comfy’s managed service for running workflows on cloud infrastructure. Comfy Cloud is a stateful application. Your account carries state that persists across jobs: credits and subscription tier, uploaded assets and generated outputs, the job queue, and the set of installed models and nodes. The v1 API is the surface for that whole application, so it contains functionality not supported in the portable Comfy API v2, such as queue management, model browsing, node definitions, and account endpoints. Use v2 (or the SDKs that wrap it) to submit workflows and retrieve results in a way that also works against serverless deployments and self-hosted ComfyUI. Use v1 for the Cloud-specific capabilities around it. To run workflows, start with the Comfy Cloud quickstart and the Comfy SDKs. Credits and concurrency limits are covered on the Comfy Cloud page; runnable v1 examples are in the Cloud API Reference. This page covers the v1-specific surface: authentication and the endpoints v2 does not expose.
Subscription required: API access requires a paid Comfy Cloud subscription; the Free tier does not include it. See the pricing plans.

​
Base URL

​
Authentication

All v1 requests require an API key passed in the X-API-Key header:
See Getting an API Key for instructions on creating and managing keys. An invalid or missing key returns 401. A key on an inactive subscription returns 429. The same key is used for Partner Nodes. Over HTTP you pass it again in extra_data.api_key_comfy_org; see Using Partner Nodes for examples.

​
What the SDKs Don’t Cover Yet

The SDKs cover running a workflow, getting the results back, and canceling a job. The rest of the Cloud surface is reachable over HTTP only, so call these endpoints directly even if you use an SDK for execution. Canceling a job is covered by both: the SDKs cancel a job you hold a handle to, and POST /api/queue cancels by ID.

​
Available Endpoints

​
Error Handling

REST endpoints return standard HTTP status codes: The SDKs raise these as typed exceptions instead, including Unauthorized, InvalidWorkflow, InsufficientCredits, QueueFull, and JobFailed, all extending ComfyError. Execution failures are separate from HTTP errors. See Error Handling for the exception_type values delivered during execution.

​
Next Steps

Comfy Cloud

Quickstart, credits, and concurrency limits.

Cloud API Reference

Complete endpoint documentation with curl, Python, and TypeScript examples.

Comfy API v2 Reference

The versioned HTTP API underneath both SDKs. Use it from any language.

OpenAPI Specification

Machine-readable API spec for code generation.