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 '{}'
{
  "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" }
  }
]
​
identities
object[]

Activates an authenticated session.

Beta Capability. Contact support to enable.

Example:
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Response

Successfully returned a browser object

​
data
object