Skip to main content
POST
/
v1
/
sessions
Start Browser Session
curl --request POST \
  --url https://api.anchorbrowser.io/v1/sessions \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{
  "session": {
    "initial_url": "<string>",
    "recording": {
      "active": true
    },
    "proxy": {
      "active": true,
      "type": "anchor_proxy",
      "country_code": "af",
      "region": "<string>",
      "city": "<string>"
    },
    "timeout": {
      "max_duration": 123,
      "idle_timeout": 123
    },
    "live_view": {
      "read_only": true
    }
  },
  "browser": {
    "profile": {
      "name": "<string>",
      "persist": true
    },
    "adblock": {
      "active": true
    },
    "popup_blocker": {
      "active": true
    },
    "captcha_solver": {
      "active": true
    },
    "headless": {
      "active": true
    },
    "viewport": {
      "width": 123,
      "height": 123
    },
    "fullscreen": {
      "active": true
    },
    "p2p_download": {
      "active": true
    },
    "extensions": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "disable_web_security": {
      "active": true
    },
    "extra_stealth": {
      "active": true
    }
  },
  "integrations": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "1PASSWORD",
      "configuration": {
        "load_mode": "all"
      }
    }
  ]
}'
{
  "data": {
    "id": "<string>",
    "cdp_url": "<string>",
    "live_view_url": "<string>"
  }
}

Authorizations

anchor-api-key
string
header
required

API key passed in the header

Body

application/json
session
object

Session-related configurations.

browser
object

Browser-specific configurations.

integrations
object[]

Array of integrations to load in the browser session. Integrations must be previously created using the Integrations API.

Example:
[
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "1PASSWORD",
"configuration": { "load_mode": "all" }
}
]

Response

Successfully returned a browser object

data
object
I