Skip to content

Document read-only and control live view URLs - #726

Open
masnwilliams wants to merge 2 commits into
mainfrom
hypeship/live-view-scoped-urls
Open

masnwilliams wants to merge 2 commits into
mainfrom
hypeship/live-view-scoped-urls

Conversation

@masnwilliams

@masnwilliams masnwilliams commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds a "Read-only and control URLs" section to the live view page for the new POST /browsers/{id_or_name}/live_view endpoint:

  • what read and control URLs allow
  • TypeScript and Python examples with scope and ttl_seconds
  • lifetime: ttl_seconds, browser deletion and pool release
  • a note that read-only URLs need a recent browser image

It also mentions ttl_seconds under URL lifetime.

Before merging

  • Merge once the endpoint is available.
  • Check the SDK method names (kernel.browsers.liveView.create / kernel.browsers.live_view.create) against the generated SDKs.

Note

Low Risk
Documentation-only changes with no runtime or security logic modifications in this diff.

Overview
Documents how to mint scoped live view URLs via the live view create API, separate from the existing readOnly query parameter on browser_live_view_url.

Adds a Read-only and control URLs section explaining read vs control, TypeScript/Python examples using scope and ttl_seconds, and operational guidance (per-viewer URLs, default scope, lifetime tied to browser deletion or pool release, and treating URLs as credentials). Includes a note that read-only scoped URLs require a recent browser image.

Updates URL lifetime to state that scoped URLs also expire when ttl_seconds is set.

Reviewed by Cursor Bugbot for commit ce92b84. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
Kernel 🟢 Ready View Preview Oct 28, 2026, 10:23 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — ce92b847 Deployed Oct 28, 2026 by mintlify[bot]
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.

1 participant