Skip to main content
POST
/
v1
/
sessions
/
{id}
Update a Session
curl --request POST \
  --url https://api.browserbase.com/v1/sessions/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-BB-API-Key: <api-key>' \
  --data '
{
  "status": "REQUEST_RELEASE",
  "projectId": "<string>"
}
'
{
  "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",
  "status": "PENDING",
  "proxyBytes": 123,
  "keepAlive": true,
  "region": "us-west-2",
  "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.

​
Closing a session

Use this endpoint to close an active Browserbase session before its timeout. To close the session, send status: "REQUEST_RELEASE" in the request body (projectId is optional). This tells Browserbase to end the session and helps avoid unnecessary usage charges if your work is already complete. 
{
  "status": "REQUEST_RELEASE"
}

Authorizations

​
X-BB-API-Key
string
header
required

Your Browserbase API Key.

Path Parameters

​
id
string
required

Body

application/json
​
status
enum<string>
required

Set to REQUEST_RELEASE to request that the session complete. Use before session's timeout to avoid additional charges.

Available options:
REQUEST_RELEASE
​
projectId
string

The Project ID. Can be found in Settings. Optional - if not provided, the project will be inferred from the API key.

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.