docs: add the Comfy Cloud API Keys & Secrets page (BYOK and provider credentials) by lin-bot23 · Pull Request #1796 · Comfy-Org/docs · GitHub
Skip to content

docs: add the Comfy Cloud API Keys & Secrets page (BYOK and provider credentials) - #1796

Open
lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/cloud-api-keys-secrets
Open

lin-bot23 wants to merge 1 commit into
Comfy-Org:mainfrom
lin-bot23:docs/cloud-api-keys-secrets

Conversation

@lin-bot23

Copy link
Copy Markdown
Contributor

@lin-bot23

New page for the missing Comfy Cloud API keys documentation: the API Keys & Secrets settings panel, including BYOK.

What is added

New page cloud/api-keys-and-secrets.mdx in EN, zh, ja, ko (Cloud Exclusive nav group, after Workspaces):

  • What the panel stores: encrypted provider credentials. Values are never shown again after saving.
  • How to open it: settings dialog via Ctrl + , or the Cloud menu, then Secrets.
  • How to add a secret: provider, credential type (text key, or a JSON credential of up to 1 MB), name, value.
  • How to manage secrets: edit (name and value only, the provider cannot be changed), delete (permanent).
  • BYOK: Runway and Google Gemini today for partner nodes in Comfy Cloud, enabled per workspace, and partner node calls on your own key are billed by the provider directly instead of drawing Comfy credits.
  • Credentials for private models links out to Import models instead of restating the import flow.

The page reuses the existing Secrets panel screenshots (images/cloud/import_model/setting_secerts-1.png, -2.png), so no new binary assets are added.

Fact sources

  • Official FAQ: apps/website/src/content/faq/pricing/en/byok-provider-keys.mdx and apps/website/src/content/faq/enterprise/en/byok-provider-keys.mdx in Comfy-Org/ComfyUI_frontend (BYOK scope, per-workspace activation, provider billing).
  • Frontend source on origin/main: src/platform/secrets/providers.ts, src/platform/secrets/types.ts, src/platform/secrets/api/secretsApi.ts, src/platform/secrets/components/SecretFormDialog.vue, src/platform/secrets/components/SecretListItem.vue, src/platform/secrets/composables/useSecretForm.ts, src/platform/settings/composables/useSettingUI.ts, src/locales/en/main.json (secrets).
  • Existing page cloud/import-models.mdx is the source for the BYOM side, which this page links rather than duplicates.

Related

Verification

  • python3 .github/scripts/check-anchors.py --file cloud/api-keys-and-secrets.mdx --file zh/cloud/api-keys-and-secrets.mdx --file ja/cloud/api-keys-and-secrets.mdx --file ko/cloud/api-keys-and-secrets.mdx: all anchors OK.
  • pnpm translate:sync-hash -- cloud/api-keys-and-secrets.mdx --lang zh,ja,ko: hashes in sync, no unrelated files touched.
  • docs.json: one nav entry per language, each with the correct language prefix, verified by walking the JSON.
  • Structure parity across the 4 files: 7 ## headings each, identical component counts, no em dashes, no leftover English UI labels in the localized files (UI labels follow the frontend locale strings: 设置/密钥, 設定/シークレット, 설정/시크릿, 編集/편집).
  • External links used: https://www.comfy.org/contact (200) and https://cloud.comfy.org (200).

@coderabbitai

coderabbitai Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

@comfyui-wiki

Copy link
Copy Markdown
Member

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants