Skip to main content
GET
/
v1
/
browser
/
session
Get Browser Session
curl --request GET \
  --url https://api.driver.dev/v1/browser/session \
  --header 'Authorization: Bearer <token>'
{
  "sessionId": "<string>",
  "servedBy": "<string>",
  "createdAt": "<string>",
  "stoppedAt": "<string>",
  "cdpUrl": "<string>",
  "note": "<string>",
  "bandwidthBytes": 1
}

Authorizations

​
Authorization
string
header
required

Your Driver API key. Get one at https://app.driver.dev

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 ID of the created browser session.

​
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

The total bandwidth used by the session in bytes.

Required range: x >= 0