1.7 KiB
1.7 KiB
title, description, icon
| title | description | icon |
|---|---|---|
| Getting an API Key | Learn how to create and manage your Comfy Platform API Key for accessing Cloud APIs, Partner Nodes, and more. | key |
import GetApiKey from '/snippets/get-api-key.mdx'
An API Key is your credential for accessing Comfy Platform services, including:
- Cloud API — call Comfy Cloud endpoints programmatically
- Partner Node API Integration — use paid Partner Nodes in your local workflows
- Agent Tools / MCP — connect to Comfy through MCP
- Login to ComfyUI locally — authenticate with an API Key instead of email
Creating an API Key
Managing your API Keys
You can view and manage all your API Keys on platform.comfy.org after logging in.
- View existing keys: See the name and creation date of each key
- Delete a key: If a key is compromised or no longer needed, delete it immediately
- Create additional keys: You can have multiple API Keys for different applications
Using your API Key
Once you have an API Key, you can:
- Log in to ComfyUI locally — go to Settings → User and select "Comfy API Key" login
- Call Partner Node APIs — include the key in
extra_data.api_key_comfy_orgwhen sending workflows - Use Cloud API — include the key in request headers for Cloud API endpoints
For security, never share your API Key or commit it to version control.