Get Shared Session

const options = {method: 'GET'};

fetch('https://api.browser-use.com/api/v4/share/{share_token}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "viewCount": 123,
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "model": "<string>",
      "status": "<string>",
      "result": "<string>",
      "error": "<string>",
      "events": [
        {
          "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "id": 123,
          "ts": "2023-11-07T05:31:56Z",
          "type": "<string>",
          "data": {}
        }
      ],
      "attachmentCount": 0
    }
  ],
  "nextAfter": 123,
  "hasMore": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Reference

Get Shared Session

Public transcript of a shared session (sensitive keys scrubbed).

Events come back in bounded pages: walk them by passing the previous response’s nextAfter back as since until hasMore is false (the wire is camelCase — the Python fields are next_after/has_more). Run metadata repeats on every page, so only events continues across pages. Paging exists because this is an unauthenticated read and the whole transcript in one response could occupy the event loop for seconds, starving the shared Redis client’s auth and rate-limit calls of their 50 ms deadline and silently failing them open.

Counts a view per full fetch. since makes this a live-tail poll: the share page repeats the request every few seconds while a run is unfinished, and each poll must stay cheap and must NOT inflate the view counter — a viewer idling on a running session would otherwise register a view every 10 seconds (the counter’s throttle window). Later pages of an initial load carry a cursor too, so one load counts one view, not one per page.

GET

{share_token}

Get Shared Session

const options = {method: 'GET'};

fetch('https://api.browser-use.com/api/v4/share/{share_token}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "viewCount": 123,
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "runs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "task": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "model": "<string>",
      "status": "<string>",
      "result": "<string>",
      "error": "<string>",
      "events": [
        {
          "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "id": 123,
          "ts": "2023-11-07T05:31:56Z",
          "type": "<string>",
          "data": {}
        }
      ],
      "attachmentCount": 0
    }
  ],
  "nextAfter": 123,
  "hasMore": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Path Parameters

Required string length: 32

Pattern: ^[A-Za-z0-9_-]{32}$

Query Parameters

since

integer | null

Highest event id the viewer already has. Returns only newer events (run metadata is always complete) and does not count a view.

Required range: x >= 0

limit

integer

default:100

Maximum events in this page. A page also closes at 1 MiB of event payload, so it can come back shorter. Read hasMore/nextAfter to page through the rest.

Required range: 1 <= x <= 250

Response

Successful Response

Public payload for GET /share/{token}: the session transcript with sensitive keys scrubbed. Files are listed via the separate /share/{token}/files endpoint so download URLs can be minted fresh.

sessionId

string<uuid>

required

title

string | null

required

createdAt

string<date-time>

required

viewCount

integer

required

workspaceId

string<uuid> | null

required

runs

SharedRun · object[]

required

Show child attributes

nextAfter

integer | null

hasMore

boolean

default:false

Get Started

Endpoints

Get Shared Session

Path Parameters

Query Parameters

Response