Start Browser Session
Allocates a new browser session for the user, with optional configurations for ad-blocking, captcha solving, proxy usage, and idle timeout.
curl --request POST \
--url https://api.anchorbrowser.io/v1/sessions \
--header 'Content-Type: application/json' \
--header 'anchor-api-key: <api-key>' \
--data '{
"session": {
"recording": {
"active": false
},
"proxy": {
"type": "anchor_residential",
"active": false
},
"timeout": {
"max_duration": 10,
"idle_timeout": 3
},
"live_view": {
"read_only": false
}
},
"browser": {
"profile": {
"name": "my-profile",
"persist": true,
"store_cache": true
},
"adblock": {
"active": false
},
"popup_blocker": {
"active": false
},
"captcha_solver": {
"active": false
},
"headless": {
"active": true
},
"viewport": {
"width": 1440,
"height": 900
}
}
}'{
"data": {
"id": "<string>",
"cdp_url": "<string>",
"live_view_url": "<string>"
}
}Authorizations
API key passed in the header
Body
Session-related configurations.
Configuration for session recording.
Enable or disable video recording of the browser session. Defaults to true.
false
Timeout configurations for the browser session.
Maximum amount of time (in minutes) for the browser to run before terminating. Defaults to 180.
10
The amount of time (in minutes) the browser session waits for new connections after all others are closed before stopping. Defaults to 5.
3
Browser-specific configurations.
Options for managing and persisting browser session profiles.
The name of the profile to be used during the browser session.
"my-profile"
Indicates whether the browser session profile data should be saved when the browser session ends. Defaults to false.
true
Indicates whether the browser session cache should be saved when the browser session ends. Defaults to false.
true
Configuration for ad-blocking.
Enable or disable ad-blocking. Defaults to true.
false
Configuration for popup blocking.
Blocks popups, including ads and CAPTCHA consent banners. Requires adblock to be active. Defaults to true.
false
Configuration for captcha-solving.
Enable or disable captcha-solving. Requires proxy to be active. Defaults to false.
false
Configuration for headless mode.
Whether browser should be headless or headful. Defaults to false.
true
curl --request POST \
--url https://api.anchorbrowser.io/v1/sessions \
--header 'Content-Type: application/json' \
--header 'anchor-api-key: <api-key>' \
--data '{
"session": {
"recording": {
"active": false
},
"proxy": {
"type": "anchor_residential",
"active": false
},
"timeout": {
"max_duration": 10,
"idle_timeout": 3
},
"live_view": {
"read_only": false
}
},
"browser": {
"profile": {
"name": "my-profile",
"persist": true,
"store_cache": true
},
"adblock": {
"active": false
},
"popup_blocker": {
"active": false
},
"captcha_solver": {
"active": false
},
"headless": {
"active": true
},
"viewport": {
"width": 1440,
"height": 900
}
}
}'{
"data": {
"id": "<string>",
"cdp_url": "<string>",
"live_view_url": "<string>"
}
}