Repository navigation
Document saving a running browser to a profile - #729
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
The SDKs with saveProfile are published. Also say which SDKs default to a one-minute timeout; the Go SDK has no default request timeout.
Sayan-
reviewed
Oct 28, 2026
Sayan-
approved these changes
Oct 28, 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
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.
summary
Adds a "Save a running browser to a profile" section to the profile save-and-reuse guide, covering
POST /browsers/{id_or_name}/profiles:id, or bynamewith create-on-misssave_changesAlso links to the new section from step 3 of the guide and from the profiles overview.
Examples are cURL plus TypeScript, Python and Go. The SDK snippets match the published
@onkernel/sdk0.134.0,kernel0.134.0 andkernel-go-sdkv0.133.0: the TypeScript snippet type-checks, the Go snippet passesgo vet, and the Python call matchessave_profile's signature.Merge this after the endpoint is live.
testing
mint broken-links: no broken linksNote
Low Risk
Documentation-only; no runtime or auth logic changes. Merge timing should follow the endpoint going live.
Overview
Documents
POST /browsers/{id_or_name}/profiles, which snapshots a live browser into a profile without deleting the session.The Save and reuse guide gains a full section with cURL and TypeScript, Python, and Go examples (including longer SDK timeouts for slow saves). It explains create vs overwrite by
nameorid, the Chromium stop/restart flow (clients must reconnect, tabs reload, volatile in-page state is lost), what is and isn’t in the snapshot, overlap withsave_changesand concurrent saves, inactivity timeout behavior, error codes and retries, and scoped API key permissions.The profiles overview step 3 and the delete-to-save step now link to this flow as an alternative to tearing down the browser.
Reviewed by Cursor Bugbot for commit 6c32cf4. Bugbot is set up for automated code reviews on this repo. Configure here.