POST
/
sessions
/
start
curl
curl -X POST "https://api.notte.cc/sessions/start" \
-H "Authorization: Bearer $NOTTE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"headless": true,
"solve_captchas": false,
"timeout_minutes": 3,
"proxies": false,
"browser_type": "chromium",
"user_agent": null,
"chrome_args": null,
"viewport_width": null,
"viewport_height": null,
"cdp_url": null,
"use_file_storage": false,
"screenshot_type": "last_action"
}'
{
  "session_id": "<string>",
  "timeout_minutes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "last_accessed_at": "2023-11-07T05:31:56Z",
  "duration": "<string>",
  "status": "active",
  "steps": [
    {}
  ],
  "error": "<string>",
  "credit_usage": 123,
  "proxies": false,
  "browser_type": "chromium",
  "use_file_storage": false
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-notte-request-origin
string | null
​
x-notte-sdk-version
string | null

Body

application/json

Request to start a new browser session.

​
headless
boolean
default:true

Whether to run the session in headless mode.

​
solve_captchas
boolean
default:false

Whether to try to automatically solve captchas

​
timeout_minutes
integer
default:3

Session timeout in minutes. Cannot exceed the global timeout.

Required range: 0 < x <= 30
​
proxies

List of custom proxies to use for the session. If True, the default proxies will be used.

​
browser_type
enum<string>
default:chromium

The browser type to use. Can be chromium, chrome or firefox.

Available options:
chromium,
chrome,
firefox,
chrome-nightly
​
user_agent
string | null

The user agent to use for the session

​
chrome_args
string[] | null

Overwrite the chrome instance arguments

​
viewport_width
integer | null

The width of the viewport

​
viewport_height
integer | null

The height of the viewport

​
cdp_url
string | null

The CDP URL of another remote session provider.

​
use_file_storage
boolean
default:false

Whether FileStorage should be attached to the session.

​
screenshot_type
enum<string>
default:last_action

The type of screenshot to use for the session.

Available options:
raw,
full,
last_action

Response

Successful Response

​
session_id
string
required

The ID of the session (created or existing). Use this ID to interact with the session for the next operation.

​
timeout_minutes
integer
required

Session timeout in minutes. Will timeout if now() > last access time + timeout_minutes

​
created_at
string<date-time>
required

Session creation time

​
last_accessed_at
string<date-time>
required

Last access time

​
status
enum<string>
required

Session status

Available options:
active,
closed,
error,
timed_out
​
closed_at
string<date-time> | null

Session closing time

​
duration
string<duration>

Session duration

​
steps
Steps · object[]

Steps of the session

​
error
string | null

Error message if the operation failed to complete

​
credit_usage
number | null

Credit usage for the session. None

​
proxies
boolean
default:false

Whether proxies were used for the session. True if any proxy was applied during session creation.

​
browser_type
enum<string>
default:chromium
Available options:
chromium,
chrome,
firefox,
chrome-nightly
​
use_file_storage
boolean
default:false

Whether FileStorage was attached to the session.