Skip to main content
GET

Price

Free. See Pricing.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

Response

The session.

success
any
required
creditsUsed
integer
required
costUsd
number
required

What this call cost, in dollars.

requestId
string
required
id
string
status
enum<string>
Available options:
active,
destroyed
createdAt
string<date-time>
startedAt
string<date-time>

When the session opened.

finishedAt
string<date-time> | null

When the session ended. Null while it runs.

timeoutAt
string<date-time>

When the session stops by itself if nothing else happens: the earlier of expiresAt and the idle limit after the last call, which moves forward with each call. After the session ends it is finishedAt.

lastActivity
string<date-time>
expiresAt
string<date-time>
metadata
object

The pairs sent when the session opened.

networkPolicyId
string | null

The network policy the session was opened with. Null for none.

networkPolicyVersion
integer | null

The version of that policy the session enforces now. It goes up when a change to the policy reaches the session, so a session behind the policy's version has not received the change yet.

proxyUsedMb
number | null

Traffic through all networks, in MB. Null until the session closes.

browserCredits
integer | null

Older field: the browser time in $0.002 steps. Null until the session closes.

browserCostUsd
number | null

What the time the session was open cost, in dollars. Null until it closes.

proxyCredits
integer | null

Older field: the traffic in $0.002 steps. Null until the session closes.

proxyCostUsd
number | null

What the traffic cost, in dollars. Null until the session closes.

cdpUrl
string

Connect a CDP client such as Playwright here.

liveViewUrl
string

Watch the session. Sent with streamWebView.

interactiveLiveViewUrl
string

Watch and control the session. Sent with streamWebView.

streamWebView
boolean
extensions
object[]

The extensions loaded in the session, in the order of extensionIds.

recordingStatus
enum<string>

none: the session was not recorded, or its video was deleted. recording: the session is running. processing: the session stopped and the video is being made, usually within a few minutes, or the status could not be read yet, so read it again. ready: recordingUrl works. failed: the video was never made and cannot be any more. A ready video is kept 7 days.

Available options:
none,
recording,
processing,
ready,
failed
recordingAvailable
boolean

false when recordingStatus is none or failed, true while a video is or will be there.

recordingTruncated
boolean

true when the video ends early because the session showed more than a recording can hold.

recordingUrl
string

The MP4, with no key needed, for 15 minutes. It plays and seeks in a browser or player. Sent when recordingStatus is ready. Read the session again for a new link.

reason
string

Why the session ended.

downloads
object[]
uploads
object[]