Skip to main content
GET
/
v1
/
sessions
List Sessions
curl --request GET \
  --url https://api.browserbase.com/v1/sessions \
  --header 'X-BB-API-Key: <api-key>'
[
  {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "projectId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "proxyBytes": 123,
    "keepAlive": true,
    "endedAt": "2023-11-07T05:31:56Z",
    "contextId": "<string>",
    "userMetadata": {}
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.browserbase.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-BB-API-Key
string
header
required

Your Browserbase API Key.

Query Parameters

​
status
enum<string>
Available options:
PENDING,
RUNNING,
ERROR,
TIMED_OUT,
COMPLETED
​
q
string

Query sessions by user metadata. See Querying Sessions by User Metadata for the schema of this query.

Response

200 - application/json

The request has succeeded.

​
id
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
projectId
string
required

The Project ID linked to the Session.

​
startedAt
string<date-time>
required
​
expiresAt
string<date-time>
required
​
status
enum<string>
required
Available options:
PENDING,
RUNNING,
ERROR,
TIMED_OUT,
COMPLETED
​
proxyBytes
integer
required

Bytes used via the Proxy

​
keepAlive
boolean
required

Indicates if the Session was created to be kept alive upon disconnections

​
region
enum<string>
required

The region where the Session is running.

Available options:
us-west-2,
us-east-1,
eu-central-1,
ap-southeast-1
​
endedAt
string<date-time>
​
contextId
string

Optional. The Context linked to the Session.

​
userMetadata
object

Arbitrary user metadata to attach to the session. To learn more about user metadata, see User Metadata.