Create a Session

Authorizations

X-BB-API-Key

string

headerrequired

Your Browserbase API Key.

Body

application/json

projectId

string

required

The Project ID. Can be found in Settings.

extensionId

string

The uploaded Extension ID. See Upload Extension.

browserSettings

object

Show child attributes

timeout

integer

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

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

Response

201 - 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

connectUrl

string

required

WebSocket URL to connect to the Session.

seleniumRemoteUrl

string

required

HTTP URL to connect to the Session.

signingKey

string

required

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