Skip to main content
PUT
/
cloud-providers
/
comfy-cloud
Set ComfyUI Cloud API key
curl --request PUT \
  --url https://core.cyberun.cloud/api/v1/cloud-providers/comfy-cloud \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_key": "cfy_xxxxxxxxxxxxxxxxxxxx",
  "cloud_fallback": false
}
'
{
  "provider_name": "comfy_cloud",
  "credential_status": "active",
  "cloud_fallback": false,
  "created_at": "2025-06-01T12:00:00Z",
  "updated_at": "2025-06-15T08:30:00Z",
  "key_preview": "cfy_xxxx...xxxx"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cyberun.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

User session JWT (Bearer ). Must be paired with the X-Team-ID request header on team-scoped endpoints so the server knows which team's resources to operate on.

Headers

X-Team-ID
string<uuid>

UUID of the team to scope the request to. Used by dual-auth endpoints (runtime + scoped management):

  • JWT callers MUST send it — a user may belong to multiple teams and the runtime cannot otherwise know which one to operate on. Missing header → 400.
  • Credential callers (sk-, dk-) can omit it because the team is derived from the credential row itself. Any value sent is ignored.
Example:

"019abc12-4567-7890-abcd-ef1234567891"

Body

application/json

Set or update the ComfyUI Cloud API key for a team. The API key is encrypted at rest using AES-256-GCM. Each team can have one credential per provider.

api_key
string
required

ComfyUI Cloud API key obtained from https://comfy.org/api.

Required string length: 1 - 512
Example:

"cfy_xxxxxxxxxxxxxxxxxxxx"

cloud_fallback
boolean
default:false

When enabled, tasks targeting local compute will automatically fall back to ComfyUI Cloud if no local agent is available. Requires an active API key.

Response

Cloud provider credential saved

Cloud provider credential status (API key is masked).

provider_name
string
required

Cloud provider identifier.

Example:

"comfy_cloud"

credential_status
enum<string>
required

Current status of the credential.

Available options:
active,
revoked
Example:

"active"

cloud_fallback
boolean
required

Whether automatic cloud fallback is enabled.

Example:

false

created_at
string<date-time>
required

Timestamp when the credential was first configured.

Example:

"2025-06-01T12:00:00Z"

updated_at
string<date-time>
required

Timestamp when the credential was last updated.

Example:

"2025-06-15T08:30:00Z"

key_preview
string

Masked preview of the API key (first 8 and last 4 characters).

Example:

"cfy_xxxx...xxxx"