API Reference

Browser Rendering

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Devtools

DevtoolsSession

List sessions.

client.browserRendering.devtools.session.list(SessionListParams { account_id, limit, offset } params, RequestOptionsoptions?): SessionListResponse { sessionId, closeReason, closeReasonText, 8 more }

GET/accounts/{account_id}/browser-rendering/devtools/session

Get session details.

client.browserRendering.devtools.session.get(stringsessionId, SessionGetParams { account_id } params, RequestOptionsoptions?): SessionGetResponse { sessionId, closeReason, closeReasonText, 8 more } | null

GET/accounts/{account_id}/browser-rendering/devtools/session/{session_id}

ModelsExpand Collapse

SessionListResponse = Array<SessionListResponseItem>

sessionId: string

Session ID.

formatuuid

closeReason?: string

Reason for session closure.

closeReasonText?: string

Human-readable close reason.

connectionEndTime?: number

Connection end time.

connectionId?: string

Connection ID.

connectionStartTime?: number

Connection start time.

devtoolsFrontendUrl?: string

DevTools frontend URL.

endTime?: number

Session end time.

lastUpdated?: number

Last updated timestamp.

startTime?: number

Session start time.

webSocketDebuggerUrl?: string

WebSocket URL for debugging this target.

SessionGetResponse { sessionId, closeReason, closeReasonText, 8 more }

sessionId: string

Session ID.

formatuuid

closeReason?: string

Reason for session closure.

closeReasonText?: string

Human-readable close reason.

connectionEndTime?: number

Connection end time.

connectionId?: string

Connection ID.

connectionStartTime?: number

Connection start time.

devtoolsFrontendUrl?: string

DevTools frontend URL.

endTime?: number

Session end time.

lastUpdated?: number

Last updated timestamp.

startTime?: number

Session start time.

webSocketDebuggerUrl?: string

WebSocket URL for debugging this target.

DevtoolsBrowser

Get a browser session ID.

client.browserRendering.devtools.browser.create(BrowserCreateParams { account_id, keep_alive, lab, 2 more } params, RequestOptionsoptions?): BrowserCreateResponse { sessionId, webSocketDebuggerUrl }

POST/accounts/{account_id}/browser-rendering/devtools/browser

Acquire and connect to browser session.

client.browserRendering.devtools.browser.launch(BrowserLaunchParams { account_id, keep_alive, lab, recording } params, RequestOptionsoptions?): void

GET/accounts/{account_id}/browser-rendering/devtools/browser

Connect to browser session.

client.browserRendering.devtools.browser.connect(stringsessionId, BrowserConnectParams { account_id, keep_alive, lab, recording } params, RequestOptionsoptions?): void

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}

Close browser session.

client.browserRendering.devtools.browser.delete(stringsessionId, BrowserDeleteParams { account_id } params, RequestOptionsoptions?): BrowserDeleteResponse { status }

DELETE/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}

Get browser version metadata.

client.browserRendering.devtools.browser.version(stringsessionId, BrowserVersionParams { account_id } params, RequestOptionsoptions?): BrowserVersionResponse { Browser, Protocol-Version, User-Agent, 3 more }

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/version

Get Chrome DevTools Protocol schema.

client.browserRendering.devtools.browser.protocol(stringsessionId, BrowserProtocolParams { account_id } params, RequestOptionsoptions?): BrowserProtocolResponse { domains, version }

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/protocol

ModelsExpand Collapse

BrowserCreateResponse { sessionId, webSocketDebuggerUrl }

sessionId: string

Browser session ID.

webSocketDebuggerUrl?: string

WebSocket URL for the session.

BrowserDeleteResponse { status }

status: "closing" | "closed"

One of the following:

"closing"

"closed"

BrowserVersionResponse { 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 { domains, version }

domains: Array<Domain>

List of protocol domains.

domain: string

Domain name.

commands?: Array<Record<string, unknown>>

Available commands.

dependencies?: Array<string>

Domain dependencies.

events?: Array<Record<string, unknown>>

Available events.

experimental?: boolean

Whether this domain is experimental.

types?: Array<Record<string, unknown>>

Type definitions.

version?: Version { major, minor }

Protocol version.

major: string

Major version.

minor: string

Minor version.

DevtoolsBrowserPage

Connect to a specific Chrome DevTools page.

client.browserRendering.devtools.browser.page.get(stringsessionId, stringtargetId, PageGetParams { account_id } params, RequestOptionsoptions?): void

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/page/{target_id}

DevtoolsBrowserTargets

Open a new browser tab.

client.browserRendering.devtools.browser.targets.create(stringsessionId, TargetCreateParams { account_id, url } params, RequestOptionsoptions?): TargetCreateResponse { id, type, url, 4 more }

PUT/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/new

List targets.

client.browserRendering.devtools.browser.targets.list(stringsessionId, TargetListParams { account_id } params, RequestOptionsoptions?): TargetListResponse { id, type, url, 4 more }

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list

Get a target by ID.

client.browserRendering.devtools.browser.targets.get(stringsessionId, stringtargetId, TargetGetParams { account_id } params, RequestOptionsoptions?): TargetGetResponse { id, type, url, 4 more }

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/list/{target_id}

Activate a browser target.

client.browserRendering.devtools.browser.targets.activate(stringsessionId, stringtargetId, TargetActivateParams { account_id } params, RequestOptionsoptions?): TargetActivateResponse { message }

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/activate/{target_id}

Close a browser target.

client.browserRendering.devtools.browser.targets.close(stringsessionId, stringtargetId, TargetCloseParams { account_id } params, RequestOptionsoptions?): TargetCloseResponse { message }

GET/accounts/{account_id}/browser-rendering/devtools/browser/{session_id}/json/close/{target_id}

ModelsExpand Collapse

TargetCreateResponse { 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?: string

Target description.

devtoolsFrontendUrl?: string

DevTools frontend URL.

title?: string

Title of the target.

webSocketDebuggerUrl?: string

WebSocket URL for debugging this target.

TargetListResponse = Array<TargetListResponseItem>

id: string

Target ID.

type: string

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

url: string

URL of the target.

description?: string

Target description.

devtoolsFrontendUrl?: string

DevTools frontend URL.

title?: string

Title of the target.

webSocketDebuggerUrl?: string

WebSocket URL for debugging this target.

TargetGetResponse { 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?: string

Target description.

devtoolsFrontendUrl?: string

DevTools frontend URL.

title?: string

Title of the target.

webSocketDebuggerUrl?: string

WebSocket URL for debugging this target.

TargetActivateResponse { message }

message: string

Target activated.

TargetCloseResponse { message }

message: string

Target is closing.