Sessions API
Update Session
POST
/
v1
/
sessions
/
{id}
Authorizations
X-BB-API-Key
string
headerrequiredYour Browserbase API Key.
Path Parameters
id
string
requiredBody
application/json
projectId
string
requiredThe Project ID. Can be found in Settings.
status
enum<string>
requiredSet 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
requiredcreatedAt
string
requiredupdatedAt
string
requiredprojectId
string
requiredThe Project ID linked to the Session.
startedAt
string
requiredendedAt
string
expiresAt
string
requiredstatus
enum<string>
requiredAvailable options:
RUNNING
, ERROR
, TIMED_OUT
, COMPLETED
proxyBytes
integer
requiredBytes used via the Proxy
avgCpuUsage
integer
CPU used by the Session
memoryUsage
integer
Memory used by the Session
keepAlive
boolean
requiredIndicates if the Session was created to be kept alive upon disconnections
contextId
string
Optional. The Context linked to the Session.
Was this page helpful?