JavaScript

import BrowserUse from 'browser-use-sdk';

const client = new BrowserUse({
  apiKey: 'My API Key',
});

const shareView = await client.sessions.publicShare.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(shareView.shareToken);

{
  "shareToken": "<string>",
  "shareUrl": "<string>",
  "viewCount": 123,
  "lastViewedAt": "2023-11-07T05:31:56Z"
}

Sessions

Create Session Public Share

Create a public share for a session.

Generates a public sharing link that allows anyone with the URL to view the session and its tasks. If a public share already exists for the session, it will return the existing share instead of creating a new one.

Public shares are useful for:

Sharing results with clients or team members
Demonstrating AI agent capabilities
Collaborative review of automated tasks

Args:

session_id: The unique identifier of the agent session to share

Returns:

Public share information including the share URL and usage statistics

Raises:

404: If the user agent session doesn’t exist

POST

sessions

{session_id}

public-share

JavaScript

import BrowserUse from 'browser-use-sdk';

const client = new BrowserUse({
  apiKey: 'My API Key',
});

const shareView = await client.sessions.publicShare.create('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(shareView.shareToken);

{
  "shareToken": "<string>",
  "shareUrl": "<string>",
  "viewCount": 123,
  "lastViewedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-Browser-Use-API-Key

string

header

required

Path Parameters

session_id

string<uuid>

required

Response

201

application/json

Successful Response

View model for representing a public share of a session.

Attributes: share_token: Token to access the public share. share_url: URL to access the public share. view_count: Number of times the public share has been viewed. last_viewed_at: Timestamp of the last time the public share was viewed (None if never viewed).

Get Session Public Share

Delete Session Public Share

Get Started

Platform

REST API reference

Create Session Public Share

Authorizations

Path Parameters

Response