Skip to content
Start here

Devtools

DevtoolsSession

List sessions.
GET/accounts/{account_id}/browser-rendering/devtools/session
Get session details.
GET/accounts/{account_id}/browser-rendering/devtools/session/{session_id}
ModelsExpand Collapse
SessionListResponse = array of object { sessionId, closeReason, closeReasonText, 8 more }
sessionId: string

Session ID.

formatuuid
closeReason: optional string

Reason for session closure.

closeReasonText: optional string

Human-readable close reason.

connectionEndTime: optional number

Connection end time.

connectionId: optional string

Connection ID.

connectionStartTime: optional number

Connection start time.

devtoolsFrontendUrl: optional string

DevTools frontend URL.

endTime: optional number

Session end time.

lastUpdated: optional number

Last updated timestamp.

startTime: optional number

Session start time.

webSocketDebuggerUrl: optional string

WebSocket URL for debugging this target.

SessionGetResponse object { sessionId, closeReason, closeReasonText, 8 more }
sessionId: string

Session ID.

formatuuid
closeReason: optional string

Reason for session closure.

closeReasonText: optional string

Human-readable close reason.

connectionEndTime: optional number

Connection end time.

connectionId: optional string

Connection ID.

connectionStartTime: optional number

Connection start time.

devtoolsFrontendUrl: optional string

DevTools frontend URL.

endTime: optional number

Session end time.

lastUpdated: optional number

Last updated timestamp.

startTime: optional number

Session start time.

webSocketDebuggerUrl: optional string

WebSocket URL for debugging this target.

DevtoolsBrowser

Get a browser session ID.
POST/accounts/{account_id}/browser-rendering/devtools/browser
Acquire and connect to browser session.
GET/accounts/{account_id}/browser-rendering/devtools/browser
Connect to browser session.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}
Close browser session.
DELETE/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}
Get browser version metadata.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/version
Get Chrome DevTools Protocol schema.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/protocol
ModelsExpand Collapse
BrowserCreateResponse object { sessionId, webSocketDebuggerUrl }
sessionId: string

Browser session ID.

webSocketDebuggerUrl: optional string

WebSocket URL for the session.

BrowserDeleteResponse object { status }
status: "closing" or "closed"
One of the following:
"closing"
"closed"
BrowserVersionResponse object { Browser, "Protocol-Version", "User-Agent", 3 more }
Browser: string

Browser name and version.

"Protocol-Version": string

Chrome DevTools Protocol version.

"User-Agent": string

User agent string.

"V8-Version": string

V8 JavaScript engine version.

"WebKit-Version": string

WebKit version.

webSocketDebuggerUrl: string

WebSocket URL for debugging the browser.

BrowserProtocolResponse object { domains, version }
domains: array of object { domain, commands, dependencies, 3 more }

List of protocol domains.

domain: string

Domain name.

commands: optional array of map[unknown]

Available commands.

dependencies: optional array of string

Domain dependencies.

events: optional array of map[unknown]

Available events.

experimental: optional boolean

Whether this domain is experimental.

types: optional array of map[unknown]

Type definitions.

version: optional object { major, minor }

Protocol version.

major: string

Major version.

minor: string

Minor version.

DevtoolsBrowserPage

Connect to a specific Chrome DevTools page.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/page/{target_id}

DevtoolsBrowserTargets

Open a new browser tab.
PUT/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/new
List targets.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list
Get a target by ID.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list/{target_id}
Activate a browser target.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/activate/{target_id}
Close a browser target.
GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/close/{target_id}
ModelsExpand Collapse
TargetCreateResponse object { id, type, url, 4 more }
id: string

Target ID.

type: string

Target type (page, background_page, worker, etc.).

url: string

URL of the target.

description: optional string

Target description.

devtoolsFrontendUrl: optional string

DevTools frontend URL.

title: optional string

Title of the target.

webSocketDebuggerUrl: optional string

WebSocket URL for debugging this target.

TargetListResponse = array of object { id, type, url, 4 more }
id: string

Target ID.

type: string

Target type (page, background_page, worker, etc.).

url: string

URL of the target.

description: optional string

Target description.

devtoolsFrontendUrl: optional string

DevTools frontend URL.

title: optional string

Title of the target.

webSocketDebuggerUrl: optional string

WebSocket URL for debugging this target.

TargetGetResponse object { id, type, url, 4 more }
id: string

Target ID.

type: string

Target type (page, background_page, worker, etc.).

url: string

URL of the target.

description: optional string

Target description.

devtoolsFrontendUrl: optional string

DevTools frontend URL.

title: optional string

Title of the target.

webSocketDebuggerUrl: optional string

WebSocket URL for debugging this target.

TargetActivateResponse object { message }
message: string

Target activated.

TargetCloseResponse object { message }
message: string

Target is closing.