Skip to content

GET /connect

Creates a browser on the cloud platform and returns the direct CDP WebSocket URL. After this call, your CDP traffic goes directly to the browser. The gateway is not in the data path.

URL: GET /connect

Auth: x-api-key header and/or token query parameter

Cloud supports the same parameters as the local /connect endpoint. Use your API key with the x-api-key header, Authorization: Bearer, or token query parameter.

Parameter Default Example Description
headlesstrueheadless=falseRun with or without a visible browser window.
oslinuxos=windowsFingerprint OS: windows, linux, android, macos.
browser_namechromebrowser_name=chromeBrowser fingerprint type.
browser_version_minlatestbrowser_version_min=146Minimum Chrome version to emulate.
browser_version_maxlatestbrowser_version_max=146Maximum Chrome version to emulate.
proxynoneproxy=http://user:pass@host:portRoute browser traffic through an HTTP proxy.
browser_languageautobrowser_language=en-USAccept-Language value.
ui_languageautoui_language=en-USBrowser UI locale.
screen_width_minautoscreen_width_min=1366Minimum screen width.
screen_height_minautoscreen_height_min=768Minimum screen height.
vncfalsevnc=trueReturn an x-vnc-url header for live viewing.
keepAlivefalsekeepAlive=trueKeep the browser open across CDP disconnects.
sessionIdnonesessionId=br_...Reconnect to an existing keep-alive session.
maxLifetimenonemaxLifetime=300Hard session TTL in seconds.
tokennonetoken=YOUR_API_KEYAPI key query parameter for cloud or authenticated deployments.

Body: Plain text CDP WebSocket URL

Headers:

HeaderDescription
x-session-idUnique session identifier (use for reconnection)
x-vnc-urlnoVNC URL (when vnc=true)
Terminal window
curl -v "https://cloud.rayobrowse.com/connect?os=windows&vnc=true" \
-H "x-api-key: your-key"

Response:

< x-session-id: br_a7f3e91c20d84b01
< x-vnc-url: https://143.198.72.51:6080/vnc.html?path=vnc/br_a7f3e91c20d84b01
<
wss://143.198.72.51:9222/cdp/br_a7f3e91c20d84b01