How to generate a Comfy API key

Last updated: September 29, 2026

This article explains how to create and manage your Comfy API key.

Q. How do I generate a Comfy API key?

To create a Comfy API key:

  1. Sign in (or create an account) at platform.comfy.org

  2. Open Profile → API Keys

  3. Create a new key and give it a name

  4. Copy and store the key securely

Please note:

  • API keys are only shown once when created

  • Lost keys cannot be retrieved later

  • If needed, create a new key and delete the old one

Q. Where can I use my Comfy API key?

The same Comfy API key works across Comfy services, including:

  • Comfy API deployments

  • Comfy Router

  • Comfy API v2 and the SDKs

  • comfy-cli, for Comfy API builds and deployments

  • Partner Nodes

  • Headless usage and custom integrations

  • Cloud MCP

  • The v1 Cloud API (deprecated)

Q. How do I use my API key?

Usage depends on where you're connecting:

  • ComfyUI app / Partner Nodes → Add the key in Settings

  • Comfy API deployments and Comfy API v2 → Pass the key in the Authorization: Bearer <your-api-key> header

  • Comfy Router → Pass the key in the X-API-Key header (Authorization: Bearer also works)

  • comfy-cli → Set the key in COMFY_CLOUD_API_KEY, or sign in with comfy cloud login

  • Headless / custom frontend → Pass the key under extra_data.api_key_comfy_org

  • v1 Cloud API (deprecated) → Pass the key using the X-API-Key header

For implementation details:

👉 See Comfy Docs - ComfyUI Account API Key Integration at https://docs.comfy.org/development/comfyui-server/api-key-integration

👉 See Comfy Docs - Comfy SDKs at https://docs.comfy.org/development/api-development/sdks

Q. How do I manage my API keys?

You can create multiple API keys for different apps.

To manage keys:

  1. Open platform.comfy.org

  2. Go to Profile → API Keys

From there you can:

  • Create new keys

  • View existing keys

  • Delete keys

If a key is exposed or compromised, delete it and generate a new one.

Q. What's the difference between Comfy API keys and Registry API keys?

These are different keys and are used for different purposes.

  • Comfy API key → Used for Cloud, APIs, Partner Nodes, and related integrations

  • Registry publishing API key → Used only for publishing custom nodes

Please make sure you're using the correct key.

For Registry publishing:

👉 See Comfy Docs - Registry Publishing at https://docs.comfy.org/registry/publishing

Q. Do I need an API key if I use ComfyUI normally?

No. Standard account login handles normal usage in ComfyUI.

You mainly need an API key for:

  • LAN or non-whitelisted environments

  • Headless usage

  • Comfy API deployments

  • Comfy Router

  • Comfy API v2 and the SDKs

  • Cloud MCP

Q. I lost my API key. Can I recover it?

No. API keys are shown only once.

If you no longer have access to the key:

  • Delete the old key

  • Generate a new one

Q. Where can I learn more?