Skip to content

Open-source Python library for AI browser agents, plus Browser Use Cloud: stealth browsers and a hosted agent API.

Update all parameters

Magnus Müllerb3594dd0fdd6
diff --git a/docs/customize/browser-parameters.mdx b/docs/customize/browser-parameters.mdx
index 768ddbf79..a694daef5 100644
--- a/docs/customize/browser-parameters.mdx
+++ b/docs/customize/browser-parameters.mdx
@@ -5,79 +5,98 @@ icon: "sliders"
mode: "wide"
---
-
-### Core Settings
-- `cdp_url`: CDP URL for connecting to existing browser instance (e.g., `http://localhost:9222`)
+## Core Settings
+- `cdp_url`: CDP URL for connecting to existing browser instance (e.g., `"http://localhost:9222"`)
- `is_local` (default: `True`): Whether this is a local browser instance. Set to `False` for remote browsers
-### Display & Appearance
-- `headless` (default: `None`): Run browser without UI. Auto-detects based on display availability
-- `window_size`: Browser window size for headful mode (e.g., `{'width': 1920, 'height': 1080}`)
-- `window_position` (default: `{'width': 0, 'height': 0}`): Window position from top-left corner
-- `viewport`: Content area size (e.g., `{'width': 1280, 'height': 720}`)
-- `device_scale_factor`: Device scale factor (DPI). Set to 2 or 3 for high-resolution screenshots
+## Display & Appearance
+- `headless` (default: `None`): Run browser without UI. Auto-detects based on display availability (`True`/`False`/`None`)
+- `window_size`: Browser window size for headful mode. Use dict `{'width': 1920, 'height': 1080}` or `ViewportSize` object
+- `window_position` (default: `{'width': 0, 'height': 0}`): Window position from top-left corner in pixels
+- `viewport`: Content area size, same format as `window_size`. Use `{'width': 1280, 'height': 720}` or `ViewportSize` object
+- `no_viewport` (default: `None`): Disable viewport emulation, content fits to window size
+- `device_scale_factor`: Device scale factor (DPI). Set to `2.0` or `3.0` for high-resolution screenshots
+- `color_scheme` (default: `'light'`): Preferred color scheme (`'light'`, `'dark'`, `'no-preference'`)
+- `contrast` (default: `'no-preference'`): High contrast mode (`'no-preference'`, `'more'`)
+- `reduced_motion` (default: `'no-preference'`): Motion preference (`'reduce'`, `'no-preference'`)
+- `forced_colors` (default: `'none'`): Forced colors mode (`'active'`, `'none'`)
-### Browser Behavior
+## Browser Behavior
- `stealth` (default: `False`): Use stealth techniques to avoid bot detection
- `keep_alive` (default: `None`): Keep browser running after agent completes
-- `allowed_domains`: Restrict navigation to specific domains (e.g., `['*.google.com']`)
-- `enable_default_extensions` (default: `True`): Load automation extensions (uBlock, cookie handlers)
-
-### User Data & Profiles
-- `user_data_dir` (default: `'~/.config/browseruse/profiles/default'`): Directory for browser profile data. Set to `None` for incognito
-- `profile_directory` (default: `'Default'`): Chrome profile subdirectory name
-- `storage_state`: Browser storage state (cookies, localStorage). Can be file path or dict
-
-### Network & Security
-- `proxy`: Proxy configuration using `ProxySettings(server, username, password, bypass)`
-- `permissions` (default: `['clipboardReadWrite', 'notifications']`): Browser permissions to grant
+- `allowed_domains`: Restrict navigation to specific domains. Use list like `['*.google.com', 'https://example.com', 'chrome-extension://*']`
+- `enable_default_extensions` (default: `True`): Load automation extensions (uBlock Origin, cookie handlers, ClearURLs)
+- `cross_origin_iframes` (default: `False`): Enable cross-origin iframe support (may cause complexity)
+
+## User Data & Profiles
+- `user_data_dir` (default: auto-generated temp): Directory for browser profile data. Use `None` for incognito mode
+- `profile_directory` (default: `'Default'`): Chrome profile subdirectory name (`'Profile 1'`, `'Work Profile'`, etc.)
+- `storage_state`: Browser storage state (cookies, localStorage). Can be file path string or dict object
+- `cookies_file`: **DEPRECATED** - Use `storage_state` instead
+
+## Network & Security
+- `proxy`: Proxy configuration using `ProxySettings(server='http://host:8080', bypass='localhost,127.0.0.1', username='user', password='pass')`
+- `permissions` (default: `['clipboardReadWrite', 'notifications']`): Browser permissions to grant. Use list like `['camera', 'microphone', 'geolocation']`
- `bypass_csp` (default: `False`): Bypass Content Security Policy (increases bot detection risk)
- `ignore_https_errors` (default: `False`): Ignore HTTPS certificate errors
-- `extra_http_headers`: Additional HTTP headers sent with every request
-
-### Browser Launch
-- `executable_path`: Path to browser executable for custom installations
+- `extra_http_headers`: Additional HTTP headers sent with every request. Use dict like `{'Accept-Language': 'en-US', 'Custom-Header': 'value'}`
+- `headers`: Additional HTTP headers for connect requests (remote browsers only)
+
+## Browser Launch
+- `executable_path`: Path to browser executable for custom installations. Platform examples:
+ - macOS: `'/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'`
+ - Windows: `'C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe'`
+ - Linux: `'/usr/bin/google-chrome'`
- `channel`: Browser channel (`'chromium'`, `'chrome'`, `'chrome-beta'`, `'msedge'`, etc.)
-- `args`: Additional command-line arguments for the browser
-- `env`: Environment variables for browser process
-- `chromium_sandbox` (default: `True`): Enable Chromium sandboxing (auto-disabled in Docker)
+- `args`: Additional command-line arguments for the browser. Use list format: `['--disable-gpu', '--custom-flag=value', '--another-flag']`
+- `env`: Environment variables for browser process. Use dict like `{'DISPLAY': ':0', 'LANG': 'en_US.UTF-8', 'CUSTOM_VAR': 'test'}`
+- `chromium_sandbox` (default: `True` except in Docker): Enable Chromium sandboxing for security
- `devtools` (default: `False`): Open DevTools panel automatically (requires `headless=False`)
+- `ignore_default_args`: List of default args to disable, or `True` to disable all. Use list like `['--enable-automation', '--disable-extensions']`
-### Timing & Performance
-- `default_timeout`: Default timeout for browser operations in milliseconds
-- `default_navigation_timeout`: Default timeout for page navigation
-- `minimum_wait_page_load_time` (default: `0.25`): Minimum time to wait before capturing page state
-- `wait_for_network_idle_page_load_time` (default: `0.5`): Time to wait for network activity to cease
-- `maximum_wait_page_load_time` (default: `5.0`): Maximum time to wait for page load
-- `wait_between_actions` (default: `0.5`): Time to wait between agent actions
+## Timing & Performance
- `slow_mo` (default: `0.0`): Slow down actions by this many milliseconds
-
-### AI Integration
+- `timeout` (default: `30000`): Default timeout for browser operations in milliseconds
+- `default_timeout`: Default timeout for playwright calls in milliseconds
+- `default_navigation_timeout`: Default timeout for page navigation in milliseconds
+- `minimum_wait_page_load_time` (default: `0.25`): Minimum time to wait before capturing page state in seconds
+- `wait_for_network_idle_page_load_time` (default: `0.5`): Time to wait for network activity to cease in seconds
+- `maximum_wait_page_load_time` (default: `5.0`): Maximum time to wait for page load in seconds
+- `wait_between_actions` (default: `0.5`): Time to wait between agent actions in seconds
+
+## AI Integration
- `highlight_elements` (default: `True`): Highlight interactive elements for AI vision
- `viewport_expansion` (default: `500`): Viewport expansion in pixels for AI context
-- `include_dynamic_attributes` (default: `True`): Include dynamic attributes in selectors
+- `include_dynamic_attributes` (default: `True`): Include dynamic attributes in selectors for better element identification
-### Downloads & Files
+## Downloads & Files
- `accept_downloads` (default: `True`): Automatically accept all downloads
-- `downloads_path`: Directory for downloaded files
-- `auto_download_pdfs` (default: `True`): Automatically download PDFs
+- `downloads_path`: Directory for downloaded files. Use string like `'./downloads'` or `Path` object
+- `auto_download_pdfs` (default: `True`): Automatically download PDFs instead of viewing in browser
-### Device Emulation
-- `user_agent`: Custom user agent string
+## Device Emulation
+- `user_agent`: Custom user agent string. Example: `'Mozilla/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X)'`
- `is_mobile` (default: `False`): Enable mobile viewport and touch events
-- `locale`: User locale (e.g., `'en-GB'`, `'de-DE'`)
-- `timezone_id`: Timezone identifier (e.g., `'America/New_York'`, `'UTC'`)
-- `color_scheme` (default: `'light'`): Preferred color scheme (`'light'`, `'dark'`, `'no-preference'`)
+- `has_touch` (default: `False`): Enable touch events for mobile emulation
+- `locale`: User locale like `'en-GB'`, `'de-DE'`, `'ja-JP'`
+- `timezone_id`: Timezone identifier like `'America/New_York'`, `'Europe/London'`, `'UTC'`
+- `screen`: Screen size information, same format as `window_size`
-### Recording
+## Recording & Debugging
- `record_video_dir`: Directory to save video recordings as `.webm` files
- `record_har_path`: Path to save network trace files as `.har` format
-- `traces_dir`: Directory to save complete trace files
-
-### Advanced Options
-- `disable_security` (default: `False`): ⚠️ NOT RECOMMENDED. Disables all browser security features
-- `deterministic_rendering` (default: `False`): ⚠️ NOT RECOMMENDED. Forces consistent rendering but reduces performance
-- `cross_origin_iframes` (default: `False`): Enable cross-origin iframe support
+- `traces_dir`: Directory to save complete Playwright trace files for debugging
+- `record_har_content` (default: `'embed'`): HAR content mode (`'omit'`, `'embed'`, `'attach'`)
+- `record_har_mode` (default: `'full'`): HAR recording mode (`'full'`, `'minimal'`)
+
+## Advanced Options
+- `disable_security` (default: `False`): ⚠️ **NOT RECOMMENDED** - Disables all browser security features
+- `deterministic_rendering` (default: `False`): ⚠️ **NOT RECOMMENDED** - Forces consistent rendering but reduces performance
+- `java_script_enabled` (default: `True`): Enable/disable JavaScript execution
+- `offline` (default: `False`): Start browser in offline mode
+- `strict_selectors` (default: `False`): Use strict selector matching
+- `base_url`: Base URL for relative navigation
+- `service_workers` (default: `'allow'`): Service worker policy (`'allow'`, `'block'`)
---
@@ -89,7 +108,6 @@ profile = BrowserProfile(headless=False, stealth=True)
browser = Browser(browser_profile=profile)
```
-
## Browser vs BrowserSession
`Browser` is an alias for `BrowserSession` - they are exactly the same class: