Add Troubleshooting Gemini API keys section#271
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new troubleshooting section to the Gemini Live integration guide explaining why invalid/unauthorized Gemini API keys may appear to “fail silently” and where errors actually surface during Live connection attempts.
Changes:
- Introduces a “Troubleshooting Gemini API keys” section describing asynchronous error surfacing for Live sessions.
- Adds a TypeScript snippet showing
onerror/onclosecallback logging for diagnosis. - Lists common failure causes (project/API enablement, region restrictions, model-specific close codes) and suggested remediation steps.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Document why a bad Gemini API key fails silently: createClient does no network call, so auth/access failures surface only via the Live session onerror/onclose callbacks. Covers common causes (wrong/mistyped key, wrong project, API not enabled, region block, native-audio 1008 'leaked'/1011 model-specific rejection) and how to fix.
roznawsk
force-pushed
the
docs/gemini-api-key-troubleshooting
branch
from
12482cf to
ef2fd70
Compare
…) can still reject (Copilot)
…to fce-3076 (e26aca8)
The admonition said the key is only exercised at live.connect() and that auth failures surface via callbacks rather than thrown, which contradicted the snippet calling checkCredentials() (a throwing network check) first. Scope the connect-path claim to the unverified case and introduce checkCredentials as the explicit fail-fast check.
czerwiukk
approved these changes
Jul 1, 2026
Co-authored-by: adrian <33912477+czerwiukk@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Document why a bad Gemini API key fails silently: createClient does no network call, so auth/access failures surface only via the Live session onerror/onclose callbacks. Covers common causes (wrong/mistyped key, wrong project, API not enabled, region block, native-audio 1008 'leaked'/1011 model-specific rejection) and how to fix.