v2

latestOpenAPI 3.1.02026-07-3176157210.9 KB

sessions

Session Start

post/sessions/start

Headers

x-notte-request-originstring nullable

x-notte-sdk-versionstring nullable

Request body

headlessboolean

Whether to run the session in headless mode.

solve_captchasboolean

Whether to try to automatically solve captchas

max_duration_minutesinteger

Maximum session lifetime in minutes (absolute maximum, not affected by activity).

idle_timeout_minutesinteger

Idle timeout in minutes. Session closes after this period of inactivity (resets on each operation).

browser_type'chromium' | 'chrome' | 'chrome-nightly' | 'chrome-turbo'

The browser type to use. Supported values are chromium and chrome. chrome-nightly and chrome-turbo are legacy aliases for chrome.

user_agentstring nullable

The user agent to use for the session

chrome_argsstring[] nullable

Overwrite the chrome instance arguments

viewport_widthinteger nullable

The width of the viewport

viewport_heightinteger nullable

The height of the viewport

aspect_ratio'5:4' | '16:9' nullable

Viewport shape preset. When set, the backend fits the largest rectangle of this aspect ratio inside the sampled available screen area. Cannot be combined with explicit viewport_width/viewport_height.

cdp_urlstring nullable

The CDP URL of another remote session provider.

use_file_storageboolean

Whether FileStorage should be attached to the session.

screenshot_type'raw' | 'full' | 'last_action'

The type of screenshot to use for the session.

web_bot_authboolean

Whether to use web bot authentication.

extra_http_headersobject nullable

Extra HTTP headers to be sent with every request.

vault_idstring nullable

The vault to use for the session

Response

Successful Response

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

Session creation time

closed_atstring date-time nullable

Session closing time

last_accessed_atstring date-time required

Last access time

durationstring duration

Session duration

status'active' | 'closed' | 'error' | 'timed_out' required

Session status

stepsobject[]

Steps of the session

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'

use_file_storageboolean

Whether FileStorage was attached to the session.

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

headlessboolean

Whether to run the session in headless mode.

solve_captchasboolean nullable

Whether to solve captchas.

cdp_urlstring nullable

The URL to connect to the CDP server.

viewer_urlstring nullable

The remote session viewer URL.

web_bot_authboolean

Whether to use web bot authentication.

timeout_minutesinteger required