record_sessionboolean
Whether saved session replay is enabled. Defaults to true.
log_sessionboolean
Whether saved browser session logs are enabled. Defaults to true.
session_idstring required
The ID of the session (created or existing). Use this ID to interact with the session for the next operation.
idle_timeout_minutesinteger required
Session idle timeout in minutes. Will timeout if now() > last access time + idle_timeout_minutes
max_duration_minutesinteger
Session max duration in minutes. Will timeout if now() > creation time + max_duration_minutes
created_atstring date-time required
closed_atstring date-time nullable
last_accessed_atstring date-time required
status'active' | 'authenticating' | 'closed' | 'error' | 'timed_out' required
close_reason'manual' | 'idle_timeout' | 'max_duration' | 'error' | 'unknown' nullable
Reason the session closed, if it is no longer active
errorstring nullable
Error message if the operation failed to complete
proxiesboolean
Whether proxies were used for the session. True if any proxy was applied during session creation.
browser_type'chromium' | 'chrome' | 'firefox' | 'chrome-nightly' | 'chrome-turbo'
network_request_bytesinteger
Total byte usage for network requests.
network_response_bytesinteger
Total byte usage for network responses.
user_agentstring nullable
The user agent to use for the session
viewport_widthinteger nullable
The width of the viewport
viewport_heightinteger nullable
The height of the viewport
solve_captchasboolean nullable
Whether to solve captchas.
cdp_urlstring nullable
The URL to connect to the CDP server.
playwright_urlstring nullable
The WebSocket URL for Playwright's chromium.connect(), when supported by the server. Requires a matching Playwright client version. This is a live browser connection, not a replay URL.
viewer_urlstring nullable
The remote session viewer URL.
web_bot_authboolean
Whether to use web bot authentication.
auth_idsstring[]
Managed Auth connection IDs attached to this session.
system_hiddenboolean
Whether this session is an internal system run. Internal system runs are omitted from session.list() unless include_system=True is requested.
timeout_minutesinteger required