Skip to content

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

Merged
andrewleesteele merged 2 commits into
mainfrom
hypeship/live-view-scoped-urls
Nov 2, 2026
Merged

andrewleesteele merged 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 POST /browsers/{id_or_name}/live_view endpoint is available in the API.
  • Check the SDK method names (kernel.browsers.liveView.create / kernel.browsers.live_view.create) against the generated SDKs.

Note

Low Risk
Documentation-only updates with no runtime or API behavior changes in this diff.

Overview
Documents how to mint scoped live view URLs (read vs control) via the SDK instead of relying only on the default browser_live_view_url and the readOnly query param.

The new Read-only and control URLs section explains sharing patterns, shows TypeScript/Python examples with scope and ttl_seconds, and covers lifetime (default read, optional TTL/expires_at, pool release, and treating URLs as credentials). It adds a note that read-only scoped URLs need a recent browser image.

The URL lifetime section now states that scoped URLs also expire when ttl_seconds is set.

Reviewed by Cursor Bugbot for commit 326b019. 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 Nov 2, 2026, 5:54 PM

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

@andrewleesteele andrewleesteele left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@andrewleesteele
andrewleesteele merged commit 33280af into main Nov 2, 2026
3 checks passed
@andrewleesteele
andrewleesteele deleted the hypeship/live-view-scoped-urls branch November 2, 2026 20:41
masnwilliams added a commit that referenced this pull request Nov 2, 2026

This branch was successfully deployed

1 active deployment
staging — 326b0199 Deployed Nov 2, 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.

2 participants