Skip to content

Conversation

@seanmcguire12
Copy link
Member

@seanmcguire12 seanmcguire12 commented Dec 13, 2025

why

  • act, extract, & observe fail, and stagehand logs AI_LoadAPIKeyError if a user attempts to use a google LLM, and has GOOGLE_API_KEY in their .env instead of GOOGLE_GENERATIVE_AI_API_KEY or GEMINI_API_KEY

what changed

  • this PR widens the accepted env vars for google models to accept GOOGLE_API_KEY

Summary by cubic

Allow GOOGLE_API_KEY for Google models by expanding the env var lookup. Fixes key-loading failures in act, extract, and observe when users set GOOGLE_API_KEY in .env.

Written for commit 4984318. Summary will update automatically on new commits.

@changeset-bot
Copy link

changeset-bot bot commented Dec 13, 2025

🦋 Changeset detected

Latest commit: 4984318

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@browserbasehq/stagehand Patch
@browserbasehq/stagehand-evals Patch
@browserbasehq/stagehand-server Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 2 files

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 13, 2025

Greptile Overview

Greptile Summary

Adds GOOGLE_API_KEY to the list of accepted environment variables for Google models specified with the google/ provider prefix (e.g., google/gemini-2.5-flash).

Changes

  • Updated providerEnvVarMap for the google provider to accept three environment variable names: GEMINI_API_KEY, GOOGLE_GENERATIVE_AI_API_KEY, and GOOGLE_API_KEY
  • This fix prevents AI_LoadAPIKeyError when users have GOOGLE_API_KEY in their .env file instead of the previously required GEMINI_API_KEY or GOOGLE_GENERATIVE_AI_API_KEY

Architecture Context

The codebase supports two formats for specifying Google models:

  1. With provider prefix (e.g., google/gemini-2.5-flash): Uses the updated google provider mapping
  2. Without prefix (e.g., gemini-1.5-flash): Falls back to GoogleClient constructor's google_legacy mapping, which already supported GOOGLE_API_KEY

This PR ensures consistent behavior across both model specification formats.

Confidence Score: 5/5

  • This PR is safe to merge with no identified risks
  • The change is minimal, well-scoped, and follows existing patterns. It adds a commonly-used environment variable name to an existing array without breaking changes. The fix addresses a real user pain point where GOOGLE_API_KEY was not recognized for google/ prefixed models, while maintaining backward compatibility with existing environment variable names.
  • No files require special attention

Important Files Changed

File Analysis

Filename Score Overview
.changeset/silent-clubs-retire.md 5/5 Adds changeset for patch release documenting the fix to load GOOGLE_API_KEY from env
packages/core/lib/utils.ts 5/5 Adds GOOGLE_API_KEY to accepted environment variables for google provider, fixing API key loading for users who use this common env var name

Sequence Diagram

sequenceDiagram
    participant User
    participant V3
    participant LLMProvider
    participant GoogleClient
    participant loadApiKeyFromEnv
    participant providerEnvVarMap

    User->>V3: Initialize with model (e.g., google/gemini-2.5-flash)
    V3->>V3: Extract provider from modelName.split("/")[0]
    V3->>loadApiKeyFromEnv: loadApiKeyFromEnv(google, logger)
    loadApiKeyFromEnv->>providerEnvVarMap: Lookup google key
    providerEnvVarMap-->>loadApiKeyFromEnv: Array of 3 env var names
    loadApiKeyFromEnv->>loadApiKeyFromEnv: Check each env var in order
    loadApiKeyFromEnv-->>V3: Return first non-empty value
    V3->>V3: Set modelClientOptions with apiKey
    V3->>LLMProvider: getClient(modelName, clientOptions)
    LLMProvider->>GoogleClient: new GoogleClient(logger, modelName, clientOptions)
    GoogleClient->>GoogleClient: Check if clientOptions has apiKey
    GoogleClient-->>LLMProvider: Return client instance
    LLMProvider-->>V3: Return client
    V3-->>User: Stagehand initialized

    Note over V3,GoogleClient: For models without prefix (e.g., gemini-1.5-flash)
    User->>V3: Initialize with model gemini-1.5-flash
    V3->>V3: Extract provider: gemini-1.5-flash (no slash)
    V3->>loadApiKeyFromEnv: loadApiKeyFromEnv(gemini-1.5-flash, logger)
    loadApiKeyFromEnv->>providerEnvVarMap: Lookup gemini-1.5-flash key
    providerEnvVarMap-->>loadApiKeyFromEnv: undefined
    loadApiKeyFromEnv-->>V3: Return undefined
    V3->>LLMProvider: getClient(modelName, clientOptions with no apiKey)
    LLMProvider->>GoogleClient: new GoogleClient(logger, modelName, clientOptions)
    GoogleClient->>GoogleClient: clientOptions has no apiKey
    GoogleClient->>loadApiKeyFromEnv: loadApiKeyFromEnv(google_legacy, logger)
    loadApiKeyFromEnv->>providerEnvVarMap: Lookup google_legacy key
    providerEnvVarMap-->>loadApiKeyFromEnv: Single env var name
    loadApiKeyFromEnv-->>GoogleClient: Return env var value
    GoogleClient-->>LLMProvider: Return client instance
    LLMProvider-->>V3: Return client
    V3-->>User: Stagehand initialized
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

@seanmcguire12 seanmcguire12 merged commit cd01f29 into main Dec 13, 2025
15 checks passed
miguelg719 pushed a commit that referenced this pull request Dec 27, 2025
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @browserbasehq/[email protected]

### Patch Changes

- [#1461](#1461)
[`0f3991e`](0f3991e)
Thanks [@tkattkat](https://github.com/tkattkat)! - Move hybrid mode out
of experimental

- [#1433](#1433)
[`e0e22e0`](e0e22e0)
Thanks [@tkattkat](https://github.com/tkattkat)! - Put hybrid mode
behind experimental

- [#1456](#1456)
[`f261051`](f261051)
Thanks [@shrey150](https://github.com/shrey150)! - Invoke page.hover for
agent move action

- [#1473](#1473)
[`e021674`](e021674)
Thanks [@shrey150](https://github.com/shrey150)! - Add safety
confirmation support for OpenAI + Google CUA

- [#1399](#1399)
[`6a5496f`](6a5496f)
Thanks [@tkattkat](https://github.com/tkattkat)! - Ensure cua agent is
killed when stagehand.close is called

- [#1436](#1436)
[`fea1700`](fea1700)
Thanks [@miguelg719](https://github.com/miguelg719)! - Fix auto-load key
for act/extract/observe parametrized models on api

- [#1439](#1439)
[`5b288d9`](5b288d9)
Thanks [@tkattkat](https://github.com/tkattkat)! - Remove base64 from
agent actions array ( still present in messages object )

- [#1408](#1408)
[`e822f5a`](e822f5a)
Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - allow for
act() cache hit when variable values change

- [#1472](#1472)
[`638efc7`](638efc7)
Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - fix: agent
cache not refreshed on action failure

- [#1424](#1424)
[`a890f16`](a890f16)
Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - fix:
"Error: -32000 Failed to convert response to JSON: CBOR: stack limit
exceeded"

- [#1418](#1418)
[`934f492`](934f492)
Thanks [@miguelg719](https://github.com/miguelg719)! - Cleanup handlers
and bus listeners on close

- [#1430](#1430)
[`bd2db92`](bd2db92)
Thanks [@shrey150](https://github.com/shrey150)! - Fix CUA model
coordinate translation

- [#1465](#1465)
[`51e0170`](51e0170)
Thanks [@miguelg719](https://github.com/miguelg719)! - Add media
resolution high provider option to gemini 3 hybrid agent

- [#1431](#1431)
[`05f5580`](05f5580)
Thanks [@tkattkat](https://github.com/tkattkat)! - Update the cache
handling for agent

- [#1432](#1432)
[`f56a9c2`](f56a9c2)
Thanks [@tkattkat](https://github.com/tkattkat)! - Deprecate cua: true
in favor of mode: "cua"

- [#1406](#1406)
[`b40ae11`](b40ae11)
Thanks [@tkattkat](https://github.com/tkattkat)! - Add support for
hovering with coordinates ( page.hover )

- [#1407](#1407)
[`0d2b398`](0d2b398)
Thanks [@tkattkat](https://github.com/tkattkat)! - Clean up page methods

- [#1412](#1412)
[`cd01f29`](cd01f29)
Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - fix: load
GOOGLE_API_KEY from .env

- [#1462](#1462)
[`a734fca`](a734fca)
Thanks [@shrey150](https://github.com/shrey150)! - fix: correctly pass
userDataDir to chrome launcher

- [#1466](#1466)
[`b342acf`](b342acf)
Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - move
playwright to optional dependencies

- [#1440](#1440)
[`2987cd1`](2987cd1)
Thanks [@tkattkat](https://github.com/tkattkat)! - [Feature] support
excluding tools from agent

- [#1455](#1455)
[`dfab1d5`](dfab1d5)
Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - update
aisdk client to better enforce structured output with deepseek models

- [#1428](#1428)
[`4d71162`](4d71162)
Thanks [@tkattkat](https://github.com/tkattkat)! - Add "hybrid" mode to
stagehand agent

## @browserbasehq/[email protected]

### Minor Changes

- [#1459](#1459)
[`abb3469`](abb3469)
Thanks [@monadoid](https://github.com/monadoid)! - Added building of
binaries

- [#1457](#1457)
[`5fc1281`](5fc1281)
Thanks [@monadoid](https://github.com/monadoid)! - First changeset for
stagehand-server

- [#1469](#1469)
[`d634d45`](d634d45)
Thanks [@monadoid](https://github.com/monadoid)! - Bump to test binary
builds

### Patch Changes

- Updated dependencies
\[[`0f3991e`](0f3991e),
[`e0e22e0`](e0e22e0),
[`f261051`](f261051),
[`e021674`](e021674),
[`6a5496f`](6a5496f),
[`fea1700`](fea1700),
[`5b288d9`](5b288d9),
[`e822f5a`](e822f5a),
[`638efc7`](638efc7),
[`a890f16`](a890f16),
[`934f492`](934f492),
[`bd2db92`](bd2db92),
[`51e0170`](51e0170),
[`05f5580`](05f5580),
[`f56a9c2`](f56a9c2),
[`b40ae11`](b40ae11),
[`0d2b398`](0d2b398),
[`cd01f29`](cd01f29),
[`a734fca`](a734fca),
[`b342acf`](b342acf),
[`2987cd1`](2987cd1),
[`dfab1d5`](dfab1d5),
[`4d71162`](4d71162)]:
    -   @browserbasehq/[email protected]

## @browserbasehq/[email protected]

### Patch Changes

- [#1373](#1373)
[`cadd192`](cadd192)
Thanks [@tkattkat](https://github.com/tkattkat)! - Update screenshot
collector in agent evals cli

- Updated dependencies
\[[`0f3991e`](0f3991e),
[`e0e22e0`](e0e22e0),
[`f261051`](f261051),
[`e021674`](e021674),
[`6a5496f`](6a5496f),
[`fea1700`](fea1700),
[`5b288d9`](5b288d9),
[`e822f5a`](e822f5a),
[`638efc7`](638efc7),
[`a890f16`](a890f16),
[`934f492`](934f492),
[`bd2db92`](bd2db92),
[`51e0170`](51e0170),
[`05f5580`](05f5580),
[`f56a9c2`](f56a9c2),
[`b40ae11`](b40ae11),
[`0d2b398`](0d2b398),
[`cd01f29`](cd01f29),
[`a734fca`](a734fca),
[`b342acf`](b342acf),
[`2987cd1`](2987cd1),
[`dfab1d5`](dfab1d5),
[`4d71162`](4d71162)]:
    -   @browserbasehq/[email protected]

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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.

3 participants