arcum42-ComfyUI_SageUtils/ref_docs/upstream_docs/cloud/openapi.md

title, description, openapi

title	description	openapi
OpenAPI Specification	Machine-readable OpenAPI specification for Comfy Cloud API	/openapi-cloud.yaml

**Experimental API:** This API is experimental and subject to change. Endpoints, request/response formats, and behavior may be modified without notice.

Comfy Cloud API Specification

This page provides the complete OpenAPI 3.0 specification for the Comfy Cloud API.

**Subscription Required:** Running workflows via the API requires an active Comfy Cloud subscription. See [pricing plans](https://www.comfy.org/cloud/pricing?utm_source=docs&utm_campaign=cloud-api) for details.

Interactive API Reference

Explore the full API with interactive documentation:

Browse endpoints, view schemas, and try requests

Using the Specification

The OpenAPI spec can be used to:

• Generate client libraries in any language using tools like OpenAPI Generator
• Import into API tools like Postman, Insomnia, or Paw
• Generate documentation using tools like Redoc or Swagger UI
• Validate requests in your application

Download

You can download the raw OpenAPI specification file:

Download the OpenAPI 3.0 specification

Authentication

All API requests require an API key passed in the X-API-Key header.

Getting an API Key

See the Cloud API Overview for step-by-step instructions with screenshots.

Using the API Key

X-API-Key: your-api-key

Base URL

Environment	URL
Production	https://cloud.comfy.org

WebSocket Connection

For real-time updates, connect to the WebSocket endpoint:

wss://cloud.comfy.org/ws?clientId={uuid}&token={api_key}

See the API Reference for message types and handling.