POST
/
v1
/
sessions
/
{id}

Authorizations

X-BB-API-Key
string
headerrequired

Your Browserbase API Key.

Path Parameters

id
string
required

Body

application/json
projectId
string
required

The Project ID. Can be found in Settings.

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

Response

200 - application/json
id
string
required
createdAt
string
required
updatedAt
string
required
projectId
string
required

The Project ID linked to the Session.

startedAt
string
required
expiresAt
string
required
status
enum<string>
required
Available options:
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
avgCpuUsage
integer

CPU used by the Session

memoryUsage
integer

Memory used by the Session

contextId
string

Optional. The Context linked to the Session.

Was this page helpful?

SessionSession Live URLs