docs: pooled browsers don't persist profile changes (save_changes)#423
Merged
Conversation
…nges) save_changes:true on a browser pool used to return 400 and is now a silent no-op (kernel/kernel#2484). Document that pooled browsers load a profile read-only and never persist changes back to it — save_changes applies only to single browser sessions — so users don't expect pooled browsers to save state. - browsers/pools/faq.mdx: new "Can pooled browsers save changes back to a profile?" Q&A - auth/profiles.mdx: Notes bullet scoping save_changes to single sessions - browsers/pools/overview.mdx: read-only profile caveat under pool config options Per review note on kernel/kernel#2484. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Risk assessment: Very Low.
Evidence from the diff: this PR adds seven lines across three .mdx documentation pages (auth/profiles.mdx, browsers/pools/faq.mdx, and browsers/pools/overview.mdx) clarifying that browser pools load profiles read-only and ignore save_changes. There are no code, config, infrastructure, generated asset, auth, billing, permission, prompt, or navigation changes. No CODEOWNERS file is present in the repo, and there were no existing approvals recorded, so approval is appropriate.
Sent by Cursor Automation: Assign PR reviewers
Sayan-
approved these changes
Jun 26, 2026
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
2 participants
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.
What
Documents that browser pools load a profile read-only — pooled browsers never persist changes back to the profile, so
save_changesdoes not apply to pools.Why
Per Sayan's review note on kernel/kernel#2484:
save_changes: trueon a pool used to return400("not supported for browser pools") and is now silently ignored. That's friendlier for SDK users, but raw-HTTP callers lose the explicit signal — so the behavior needs a line in the pool docs "so nobody expects pooled browsers to persist changes."Changes
browsers/pools/faq.mdx— new Q&A: "Can pooled browsers save changes back to a profile?" (sits next to the existing profile-update Q&A).auth/profiles.mdx— Notes bullet scopingsave_changesto single sessions, with a pool exception.browsers/pools/overview.mdx— read-only-profile caveat under Pool configuration options.The OpenAPI-generated API reference (
api-reference/browser-pools/*) is pulled from the Stainless documented spec and is already updated by #2484 — no manual edit here.Sequencing
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only changes with no runtime, API, or security impact.
Overview
Documents that browser pools load profiles read-only and never write session state back, so
save_changesonly applies tokernel.browsers.create()single sessions.Adds a Profiles Notes bullet and short caveats under pool overview (pool configuration) and pool FAQ (new Q&A). All three explain that
save_changeson a pool profile is silently ignored (not rejected), and point readers to a one-off browser withsave_changes: truewhen they need to persist profile state.Reviewed by Cursor Bugbot for commit 3da9943. Bugbot is set up for automated code reviews on this repo. Configure here.