Start Session

Start a new browser session. Configure timeout, max steps, proxies, and browser type in the request.

Important information:

The maximum session duration is set to 30 minutes and cannot be changed.
However, the session_timeout parameter in the request allows you to specify a timeout for the session steps (defaults to 3 minutes). This timeout is triggered on session inactivity, i.e when no operation (i.e agents, scrape, observe, steps, etc.) is performed for a while.
You can turn on proxies in the request to increase the chances of bypassing bot detection mechanisms (for an additional cost).
Different browser types are available with different security measures in place to prevent detection. If you are flagged as a bot try to switch to chrome or firefox instead of chromium

POST

sessions

start

{
  "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",
  "error": "<string>",
  "proxies": false,
  "browser_type": "chromium"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request to start a new browser session.

Response

200

application/json

Successful Response

The response is of type object.

{
  "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",
  "error": "<string>",
  "proxies": false,
  "browser_type": "chromium"
}

Start Session

Start a new browser session. Configure timeout, max steps, proxies, and browser type in the request.

Important information:

The maximum session duration is set to 30 minutes and cannot be changed.
However, the session_timeout parameter in the request allows you to specify a timeout for the session steps (defaults to 3 minutes). This timeout is triggered on session inactivity, i.e when no operation (i.e agents, scrape, observe, steps, etc.) is performed for a while.
You can turn on proxies in the request to increase the chances of bypassing bot detection mechanisms (for an additional cost).
Different browser types are available with different security measures in place to prevent detection. If you are flagged as a bot try to switch to chrome or firefox instead of chromium

POST

sessions

start

{
  "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",
  "error": "<string>",
  "proxies": false,
  "browser_type": "chromium"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request to start a new browser session.

Response

200

application/json

Successful Response

The response is of type object.

{
  "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",
  "error": "<string>",
  "proxies": false,
  "browser_type": "chromium"
}

Authorizations

Body

Response

Documentation

Authorizations

Body

Response