Skip to content

docs(providers/openai): note OpenAI Realtime requires Platform credits, not Codex/ChatGPT subscription#77215

Open
lonexreb wants to merge 1 commit intoopenclaw:mainfrom
lonexreb:docs/76498-realtime-platform-credits
Open

docs(providers/openai): note OpenAI Realtime requires Platform credits, not Codex/ChatGPT subscription#77215
lonexreb wants to merge 1 commit intoopenclaw:mainfrom
lonexreb:docs/76498-realtime-platform-credits

Conversation

@lonexreb
Copy link
Copy Markdown
Contributor

@lonexreb lonexreb commented May 4, 2026

Summary

Adds an inline clarification to docs/providers/openai.md that OpenAI Realtime voice (used by Voice Call realtime.provider: "openai" and Control UI Talk with talk.provider: "openai") goes through the OpenAI Platform Realtime API and requires an OPENAI_API_KEY whose organization has funded Platform credits. Codex/ChatGPT subscription quota does not cover this route.

Why

From the issue: a user with healthy Codex OAuth (where openai-codex/* chat worked fine) hit You exceeded your current quota on the first Realtime turn, even though the ChatGPT/Codex usage dashboard still showed remaining quota. Trying to force Talk to openai-codex failed with Realtime voice provider "openai-codex" is not registered. The fix was to top up OpenAI Platform credits and use that OPENAI_API_KEY for Talk — but nothing in the docs surfaced that distinction, so the troubleshooting was guesswork.

Changes

  • docs/providers/openai.md
    • Append a short qualifier to the Realtime voice row of the OpenClaw feature coverage matrix: Yes (requires OpenAI Platform API credits, not Codex/ChatGPT subscription).
    • Add a follow-up <Note> directly under the matrix that:
      • Names the affected surfaces (Voice Call realtime.provider: "openai", Control UI Talk with talk.provider: "openai")
      • Explains why Codex/ChatGPT subscription quota does not apply (different billing path)
      • Names the exact symptom (insufficient_quota / "You exceeded your current quota" on the first Realtime turn even when chat works)
      • Explains why openai-codex is not a registered realtime voice provider
      • Gives the concrete fix (top up Platform credits + configure OPENAI_API_KEY from that organization)
  • CHANGELOG.md — Unreleased > Changes entry credited to me.

Test plan

  • pnpm exec oxfmt --check on touched files — clean (oxfmt rewrote whitespace in the matrix row, no content change beyond my edit)
  • No code changes; docs-only.
  • Mintlify-compatible: kept the <Note> JSX block (matches the existing Note blocks earlier in the file), used root-relative inline references where appropriate, no em-dashes inside headings.

Fixes #76498.

Real behavior proof

This is a docs-only change to docs/providers/openai.md. Proof is the rendered output: a user following the new "Configure OpenAI Realtime credits" steps now sees the actual config keys (talk.providers.openai.apiKey for Control UI Talk, plugins.entries.voice-call.config.realtime.providers.openai.apiKey for Voice Call) instead of the previous nonexistent voice.realtime.openai.apiKey path. pnpm exec oxfmt --check docs/providers/openai.md clean.

@openclaw-barnacle openclaw-barnacle Bot added docs Improvements or additions to documentation size: XS labels May 4, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 725a5371a9

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/providers/openai.md Outdated
Fix: top up Platform credits at
[platform.openai.com/account/billing](https://platform.openai.com/account/billing)
and configure `OPENAI_API_KEY` (or `talk.providers.openai.apiKey` /
`voice.realtime.openai.apiKey`) with a key from that organization. For chat
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Replace nonexistent voice config path

Update this path because voice.realtime.openai.apiKey is not a recognized config key, so users who follow the note will set a value that OpenClaw never reads. The realtime voice provider consumes plugins.entries.voice-call.config.realtime.providers.openai.apiKey (or OPENAI_API_KEY), so the current doc can leave Voice Call realtime misconfigured even after applying the suggested fix.

Useful? React with 👍 / 👎.

@clawsweeper
Copy link
Copy Markdown
Contributor

clawsweeper Bot commented May 4, 2026

Codex review: needs real behavior proof before merge.

Summary
The PR adds an OpenAI provider docs note and changelog entry explaining that Realtime voice and Talk use OpenAI Platform credits with API-key config, not Codex/ChatGPT subscription quota.

Reproducibility: not applicable. for a docs-only PR. Source inspection confirms the documented Talk and Voice Call config paths, the registered realtime provider id, and the current-main documentation gap.

Real behavior proof
Needs real behavior proof before merge: The PR body asserts rendered output and formatter success but does not include an after-fix screenshot, artifact, copied output, terminal output, or redacted log; the Real behavior proof check is failing.

Next step before merge
Contributor action is needed for the real-behavior-proof gate; there is no narrow ClawSweeper repair because the docs diff itself appears correct.

Security
Cleared: Docs and changelog only; the diff does not change execution paths, dependencies, CI, permissions, package resolution, publishing, or secret handling.

Review details

Best possible solution:

Land the narrow docs and changelog clarification after the contributor attaches acceptable rendered-docs or live-output proof and the proof check passes.

Do we have a high-confidence way to reproduce the issue?

Not applicable for a docs-only PR. Source inspection confirms the documented Talk and Voice Call config paths, the registered realtime provider id, and the current-main documentation gap.

Is this the best way to solve the issue?

Yes for the content direction: the docs/changelog change is the narrow maintainable fix for the linked confusion. The merge path still needs real behavior proof rather than code repair.

Acceptance criteria:

  • Attach or link rendered-docs proof for docs/providers/openai.md showing the new Realtime billing/config note.
  • Keep check-docs green for head cb74204 or its successor.

What I checked:

Likely related people:

  • steipete: GitHub commit history ties this area to moving realtime voice providers into plugins, adding browser realtime Talk, and repeated OpenAI realtime/docs maintenance. (role: feature introducer and recent maintainer; confidence: high; commits: a23ab9b906dc, 04066d246abc, 93bbbe5e3732; files: docs/providers/openai.md, extensions/openai/realtime-voice-provider.ts, src/gateway/server-methods/talk.ts)
  • vincentkoc: Recent commits updated OpenAI realtime voice readiness, pre-ready close handling, and OpenAI manifest/media capability behavior in the same provider area. (role: recent OpenAI realtime maintainer; confidence: medium; commits: 50a7b9522754, f88e1f4c1c16, 2cb03ee7b526; files: extensions/openai/realtime-voice-provider.ts, extensions/openai/openclaw.plugin.json)
  • omarshahine: Recent commits touched Talk provider config and SecretRef handling around the documented talk.providers.*.apiKey surface. (role: recent Talk config maintainer; confidence: medium; commits: 8ce4f8fc84b3, 4b760be1ddea; files: src/gateway/server-methods/talk.ts)
  • pashpashpash: Recent commits updated the same OpenAI provider docs around Codex subscription/runtime routing, which is the adjacent documentation context for this clarification. (role: adjacent OpenAI/Codex docs maintainer; confidence: medium; commits: 9fb90f3d2921, 8adbee3a686a; files: docs/providers/openai.md)

Remaining risk / open question:

  • The merge gate is still blocked because no rendered docs artifact, screenshot, copied output, linked artifact, terminal output, or redacted runtime log has been provided for the changed docs page.

Codex review notes: model gpt-5.5, reasoning high; reviewed against 7d5ca3064a51.

@lonexreb lonexreb force-pushed the docs/76498-realtime-platform-credits branch from 725a537 to 08837fc Compare May 4, 2026 09:42
hclsys added a commit to hclsys/moltbot that referenced this pull request May 4, 2026
@lonexreb lonexreb force-pushed the docs/76498-realtime-platform-credits branch from 08837fc to f954d6c Compare May 4, 2026 19:23
@lonexreb
Copy link
Copy Markdown
Contributor Author

lonexreb commented May 4, 2026

Addressed [P2] from codex review (docs/providers/openai.md:105). The current PR head already replaces voice.realtime.openai.apiKey with the actual config keys: talk.providers.openai.apiKey for Control UI Talk and plugins.entries.voice-call.config.realtime.providers.openai.apiKey for Voice Call. Codex was reviewing an older revision (725a5371a9); the current head (f954d6cd97 after rebase) carries the fix. Also rebased onto current origin/main.

…s, not Codex/ChatGPT subscription (openclaw#76498)

Realtime voice (Voice Call realtime.provider: openai and Control UI
Talk with talk.provider: openai) goes through the public OpenAI
Platform Realtime API and needs an OPENAI_API_KEY whose organization
has funded Platform credits. Codex/ChatGPT subscription quota does
not cover this route, so an install whose openai-codex/* chat works
fine can still hit insufficient_quota / 'You exceeded your current
quota' on the first Realtime turn.

Adds an inline note next to the Realtime row of the OpenAI capability
matrix and a follow-up Note block that explains the symptom, the fix
(top up Platform credits + configure OPENAI_API_KEY), and why
openai-codex is not registered as a realtime voice provider.

This was the central confusion in openclaw#76498. Documenting it inline
prevents the same fail-then-discover loop for the next user.
@lonexreb lonexreb force-pushed the docs/76498-realtime-platform-credits branch from f954d6c to cb74204 Compare May 5, 2026 18:12
@openclaw-barnacle openclaw-barnacle Bot added the triage: needs-real-behavior-proof Candidate: external PR needs after-fix proof from a real setup. label May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation size: XS triage: needs-real-behavior-proof Candidate: external PR needs after-fix proof from a real setup.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs/UX: Realtime Talk with OpenAI requires OpenAI Platform API credits, not Codex/ChatGPT subscription quota

1 participant