Launch options
The JSON body of POST https://starter.cdpfleet.com/<browser>/session takes these options. Each has its own page with what it does, what it's for, which browsers take it and the cases and recipes that use it. Per browser, the same options are on its browser page; the code builder writes a program with any of them.
| Option | What it does | Browsers |
|---|---|---|
proxy | Upstream proxy for the browser. | All |
proxy_rules | Send specific destination hosts through specific proxies. | All |
proxy_updatable | Kept for compatibility: every session's proxy can now be swapped without it. | All |
inactivity_timeout | End the session after this long with no traffic on its WebSocket. | All |
overall_timeout | Hard cap on the session's total lifetime, regardless of activity. | All |
memory | Give the session 2, 3 or 4 times your plan's memory; it counts as that many times the threads. | All |
headless | Run without a display. | All |
channel | Release channel of the browser build. | Google Chrome, Microsoft Edge, Brave, Opera, Naver Whale, Yandex Browser |
version | Pin an older major version. | Google Chrome, Camoufox |
os | Operating system of the generated fingerprint. | Camoufox |
locale | Browser locale(s). | Camoufox |
geoip | Match timezone, locale, geolocation and WebRTC IP to the proxy's exit IP. | Camoufox |
humanize | Human-like cursor movement. | Camoufox |
block_images | Block all images. | Camoufox |
block_webrtc | Disable WebRTC entirely. | Camoufox |
block_webgl | Disable WebGL. | Camoufox |
disable_coop | Disable Cross-Origin-Opener-Policy. | Camoufox |
screen | Constrain the fingerprint's screen size. | Camoufox |
window | Fixed outer window size. | Camoufox |
fingerprint | Use a complete BrowserForge fingerprint. | Camoufox |
config | Override individual fingerprint properties. | Camoufox |
fonts | Extra font families to expose. | Camoufox |
custom_fonts_only | Expose only the fonts in fonts. | Camoufox |
webgl_config | Force a specific WebGL vendor/renderer pair. | Camoufox |
ff_version | Firefox major version to claim in the fingerprint. | Camoufox |
screencast | Stream the page to your code (Playwright page.screencast). | Google Chrome, Microsoft Edge, Brave, Opera, Naver Whale, Yandex Browser, Chromium, Patchright, Camoufox, Firefox, WebKit |
keep_alive | Keep the session when your client disconnects (dedicated threads only). | Google Chrome, Microsoft Edge, Brave, Opera, Naver Whale, Yandex Browser, Chromium, Patchright, Camoufox, Firefox, WebKit |
profile | Restore a saved browser profile and save it again when the session ends. | Google Chrome, Microsoft Edge, Brave, Opera, Yandex Browser, Chromium, Patchright, Camoufox, Firefox, WebKit |
record | Opt this session out of recording with false. | All |
downloads | Keep every file the browser downloads, to fetch after the session. | All |
live_view | Make a headless session watchable and controllable from outside. | Google Chrome, Microsoft Edge, Brave, Opera, Naver Whale, Yandex Browser, Chromium, Patchright, Rebrowser |
start_url | Open this page at launch so the session can be driven in live view with no client connected. | Google Chrome, Microsoft Edge, Brave, Opera, Naver Whale, Yandex Browser, Chromium, Patchright, Camoufox, Firefox, WebKit |
screen_size | Resolution of the session's own display (headful only). | All |
cdp | Also expose a Chrome DevTools Protocol endpoint (cdpUrl). | Google Chrome, Microsoft Edge, Brave, Opera, Yandex Browser, Chromium |
vpn_tunnel | VPN Tunnel: UDP/WebRTC full support — all of the browser's traffic, UDP included, goes through the residential exit. | All |
vpn | Own network (dedicated plans): send all of the browser's traffic through your own VPN instead of a proxy. | All |
main_world_eval | Allow scripts in the page's main world. | Camoufox |