Skip to content

docs(comfy-router): realtime voice (Grok Voice) session page - #2164

Draft
mattmillerai wants to merge 4 commits into
mainfrom
docs/router-realtime-grok-voice
Draft

mattmillerai wants to merge 4 commits into
mainfrom
docs/router-realtime-grok-voice

Conversation

@mattmillerai

Copy link
Copy Markdown
Member

Hold: do not merge yet

This page documents the Comfy Router realtime voice route, which is not public yet. Hold until https://github.com/Comfy-Org/cloud/pull/16874 is merged and live in prod. Then rebase on main, re-run checks, mark ready, and merge in the same window as the launch config release, not before. The PR stays a draft until then.

Closes https://linear.app/comfyorg/issue/BE-20792

What this adds

  • development/comfy-router/realtime.mdx (new, hand-written, not sync-owned): endpoint, API-key auth (header only; browsers need a server-side relay), Python websockets and Node ws connect examples, a pointer to xAI's and fal's event docs (events are relayed, not restated), the client-event policy (allowed event types, session models, no server-side tools, no image/video, 1 MiB per message, 1008 on refusal), pricing ($0.00083/s, 15-second billing ticks, final partial tick by the second), limits (one open session per account, 30-minute cap bounded by balance, per-tick balance recheck, shared per-caller request rate), the pre-upgrade refusal table (code values router.realtime.*) and the close codes (1008, 1012, 1006 with no close frame).
  • docs.json: adds the page at the end of the Router API group, after Billing.
  • development/comfy-router/api.mdx: one link in Next. A link instead of a Card keeps ja/zh/ko/es api.mdx in structure parity.

Translations follow in the regular i18n sync, as with errors and billing.

Sources

All facts are from Comfy-Org/cloud main (services/comfy-api/server/middleware/router_realtime.go, router_realtime_policy.go, router_rate_limit.go, authentication/comfy_firebase_auth.go) and the prod rate row for xai/grok-voice/realtime (0.083 cents/s).

Checks run locally

  • Structure parity (--base=origin/main --head=HEAD): OK
  • Sync-owned files: none edited
  • Link validation and anchor check: OK
  • i18n sync: expected missing-translation warnings for the new page (non-blocking)

Hand-written page for the Router realtime WebSocket route
(wss://api.comfy.org/v2/realtime/fal/xai/grok-voice/realtime): auth,
a Python and Node connect example, the client-event policy, per-second
pricing, session limits, pre-upgrade refusals and close codes. Adds it
to the Router API nav group and links it from the API overview's Next
list. Translations follow in the regular i18n sync.
@mintlify

mintlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
comfy 🟢 Ready View Preview Oct 28, 2026, 10:29 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@mattmillerai mattmillerai added the cursor-review Trigger Cursor automated review label Oct 28, 2026
@coderabbitai

coderabbitai Bot commented Oct 28, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

🌐 i18n translation sync check

English docs changed in this PR. 12 files in 4 languages may not be synced yet. The automated translation workflow handles these updates. Expand a language to see the files.

Japanese (ja): 3 files
  • ja/development/comfy-router/api.mdx
  • ja/development/comfy-router/realtime.mdx
  • ja/development/comfy-router/realtime.mdx
Simplified Chinese (zh): 3 files
  • zh/development/comfy-router/api.mdx
  • zh/development/comfy-router/realtime.mdx
  • zh/development/comfy-router/realtime.mdx
Korean (ko): 3 files
  • ko/development/comfy-router/api.mdx
  • ko/development/comfy-router/realtime.mdx
  • ko/development/comfy-router/realtime.mdx
Spanish (es): 3 files
  • es/development/comfy-router/api.mdx
  • es/development/comfy-router/realtime.mdx
  • es/development/comfy-router/realtime.mdx

Local sync: npm run translate (see README: Automated translation)

This branch was successfully deployed

1 active deployment
staging — ab90cf83 Deployed Oct 28, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cursor-review Trigger Cursor automated review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant