POST
/
v1
/
sessions

Authorizations

X-BB-API-Key
string
header
required

Body

application/json
projectId
string
required

The Project ID. Can be found in Settings.

browserSettings
object
extensionId
string

The uploaded Extension ID. See Upload Extension.

keepAlive
boolean

Set to true to keep the session alive even after disconnections. This is available on the Startup plan only.

proxies

Proxy configuration. Can be true for default proxy, or an array of proxy configurations.

region
enum<string>

The region where the Session should run.

Available options:
us-west-2,
us-east-1,
eu-central-1,
ap-southeast-1
timeout
integer

Duration in seconds after which the session will automatically end. Defaults to the Project's defaultTimeout.

Required range: 60 < x < 21600
userMetadata
any

Arbitrary user metadata to attach to the session.

Response

201 - application/json
connectUrl
string
required

WebSocket URL to connect to the Session.

createdAt
string
required
expiresAt
string
required
id
string
required
keepAlive
boolean
required

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

projectId
string
required

The Project ID linked to the Session.

proxyBytes
integer
required

Bytes used via the Proxy

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
seleniumRemoteUrl
string
required

HTTP URL to connect to the Session.

signingKey
string
required

Signing key to use when connecting to the Session via HTTP.

startedAt
string
required
status
enum<string>
required
Available options:
RUNNING,
ERROR,
TIMED_OUT,
COMPLETED
updatedAt
string
required
avgCpuUsage
integer

CPU used by the Session

contextId
string

Optional. The Context linked to the Session.

endedAt
string
memoryUsage
integer

Memory used by the Session

userMetadata
any

Arbitrary user metadata to attach to the session.