> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-chore-sync-comfy-api-v2-spec.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# v1 Cloud API Overview
> The deprecated v1 Cloud API surface: authentication and the Cloud-specific endpoints Comfy API v2 does not expose
**Deprecated:** The v1 Cloud API is deprecated in favor of [Comfy API v2](/api-reference/v2/overview). 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](/development/deploy/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](/api-reference/v2/overview), 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](/development/deploy/cloud#quickstart) and the [Comfy SDKs](/development/api-development/sdks). Credits and concurrency limits are covered on the [Comfy Cloud page](/development/deploy/cloud); runnable v1 examples are in the [Cloud API Reference](/development/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](https://www.comfy.org/cloud/pricing?utm_source=docs\&utm_campaign=cloud-api).
## Base URL
```
https://cloud.comfy.org
```
## Authentication
All v1 requests require an API key passed in the `X-API-Key` header:
```bash theme={null}
curl -X GET "https://cloud.comfy.org/api/user" \
-H "X-API-Key: $COMFY_CLOUD_API_KEY"
```
See [Getting an API Key](/development/api-development/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](/tutorials/partner-nodes/overview). Over HTTP you pass it again in `extra_data.api_key_comfy_org`; see [Using Partner Nodes](/development/cloud/api-reference#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.
| Capability | Endpoint | Reference |
| --------------------------------------------- | ----------------------- | --------------------------------------------------------------------- |
| Queue status, running and pending jobs | `GET /api/queue` | [Queue Management](/development/cloud/api-reference#queue-management) |
| Interrupt the current execution | `POST /api/interrupt` | [Queue Management](/development/cloud/api-reference#queue-management) |
| Node definitions and input specs | `GET /api/object_info` | [Object Info](/development/cloud/api-reference#object-info) |
| Browse available models | Model endpoints | [OpenAPI Specification](/development/cloud/openapi) |
| Account and user information | `GET /api/user` | [OpenAPI Specification](/development/cloud/openapi) |
| Mask uploads that reference an existing image | `POST /api/upload/mask` | [Uploading Inputs](/development/cloud/api-reference#uploading-inputs) |
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
| Category | Description |
| ------------------------------------------------------------------------------ | -------------------------------------- |
| [Workflows](/development/cloud/api-reference#running-workflows) | Submit workflows, check status |
| [Jobs](/development/cloud/api-reference#checking-job-status) | Monitor job status and queue |
| [Inputs](/development/cloud/api-reference#uploading-inputs) | Upload images, masks, and other inputs |
| [Outputs](/development/cloud/api-reference#downloading-outputs) | Download generated content |
| [WebSocket](/development/cloud/api-reference#websocket-for-real-time-progress) | Real-time progress updates |
| [Object Info](/development/cloud/api-reference#object-info) | Available nodes and their definitions |
## Error Handling
REST endpoints return standard HTTP status codes:
| Status | Description |
| ------ | ---------------------------------------------- |
| `400` | Invalid request (bad workflow, missing fields) |
| `401` | Unauthorized (invalid or missing API key) |
| `402` | Insufficient credits |
| `429` | Subscription inactive |
| `500` | Internal server error |
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](/development/cloud/api-reference#error-handling) for the `exception_type` values delivered during execution.
## Next Steps
Quickstart, credits, and concurrency limits.
Complete endpoint documentation with curl, Python, and TypeScript examples.
The versioned HTTP API underneath both SDKs. Use it from any language.
Machine-readable API spec for code generation.