Update Session

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

endedAt

string

expiresAt

string

required

status

enum<string>

required

Available options:

RUNNING,

ERROR,

TIMED_OUT,

COMPLETED

proxyBytes

integer

required

Bytes used via the Proxy

avgCpuUsage

integer

CPU used by the Session

memoryUsage

integer

Memory used by the Session

keepAlive

boolean

required

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

contextId

string

Optional. The Context linked to the Session.

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