Skip to main content
GET
Get a session

Authorizations

Authorization
string
header
required

A workspace API key from Settings → API keys in the dashboard (https://app.driver.dev), sent as a bearer token.

Query Parameters

sessionId
string
required

The ID of the browser session to retrieve.

Example:

"example-session-id"

Response

Successfully retrieved browser session.

sessionId
string
required

The session id: an opaque string; do not validate its format.

status
enum<string>
required

The status of the session.

Available options:
starting,
active,
completed,
error
servedBy
string
required

The node ID that is serving this session.

createdAt
string
required

The ISO 8601 timestamp when the session was created.

stoppedAt
string | null
required

The ISO 8601 timestamp when the session was stopped, or null if it is still active.

cdpUrl
string<uri> | null
required

The URL to access the Chrome DevTools Protocol for this session, or null if not available.

note
string | null
required

An optional note attached to the session, or null if not set.

bandwidthBytes
integer | null
required

Bandwidth used by the session in bytes: null while it runs, the metered total once it has ended (final by the time a stop call returns).

Required range: x >= 0