Skip to content

Legacy API (create_browser)

`create_browser(**kwargs) -> str`

Returns a CDP WebSocket URL. Connect to it with Playwright, Selenium, or Puppeteer.

from rayobrowse import create_browser
from playwright.sync_api import sync_playwright

ws_url = create_browser(headless=False, target_os="windows")

with sync_playwright() as p:
    browser = p.chromium.connect_over_cdp(ws_url)
    page = browser.contexts[0].pages[0]
    page.goto("https://example.com")
    browser.close()

Parameters

Parameter	Type	Default	Description
`headless`	`bool`	`False`	Run without GUI
`target_os`	`str`	`"linux"`	Fingerprint OS: `windows`, `android`, `linux`, `macos`
`browser_name`	`str`	`"chrome"`	Browser type
`browser_version_min`	`int`	`None`	Min Chrome version to emulate
`browser_version_max`	`int`	`None`	Max Chrome version to emulate
`proxy`	`str`	`None`	Proxy URL (`http://user:pass@host:port`)
`browser_language`	`str`	`None`	Language header (e.g., `"ko,en;q=0.9"`)
`fingerprint_file`	`str`	`None`	Path to a static fingerprint JSON file
`launch_args`	`list`	`None`	Extra Chromium flags
`api_key`	`str`	`None`	API key (overrides `STEALTH_BROWSER_API_KEY` env var)
`endpoint`	`str`	`None`	Daemon URL (overrides `RAYOBYTE_ENDPOINT`, default `http://localhost:9222`)

Other legacy functions

close_browser(browser_id, endpoint=None, api_key=None) — Close a specific browser
list_browsers(endpoint=None) — List active browsers
get_daemon_status(endpoint=None) — Check daemon status
ensure_daemon_running(endpoint=None) — Verify daemon is reachable

Migration to `Rayobrowse` class

# Old way
from rayobrowse import create_browser
ws_url = create_browser(headless=False, target_os="windows")

# New way
from rayobrowse import Rayobrowse
client = Rayobrowse()
ws_url = client.connect_url(os="windows", headless=False)