Skip to content
Rayobyte Docs

SDKs

These pages describe the current releases: rayobrowse 2.2.0 on PyPI and rayobrowse 0.2.0 on npm.

Both SDKs take an endpoint on the constructor. Set it to https://browser.rayobyte.com, which is the gateway every example on these pages calls.

You do not need one

Section titled “You do not need one”

GET /connect is one HTTP request and its response is a URL. curl, httpx, fetch and every other HTTP client already do the job, and the CDP URL they get is identical.

Install an SDK when you want what it wraps:

  • Reconnection by session id without building the query yourself
  • The live-view URL held on the client rather than dug out of a header
  • Typed exceptions instead of status-code branching
  • Session close and listing as method calls

The two side by side

Section titled “The two side by side”
HTTP /connect SDK
Create GET /connect returns the CDP URL connect_url() returns the CDP URL
Reconnect sessionId query parameter reconnect_url(session_id)
Live view x-vnc-url response header last_vnc_url / vncUrl
Close POST /api/browser/close close()
Errors HTTP status plus body Typed exceptions
Dependencies None One package

The SDK calls the same endpoint. Nothing it does is unavailable over HTTP.

Proxy is required either way

Section titled “Proxy is required either way”

The SDKs do not supply a proxy for you. Pass one to connect_url() or connectUrl() on every call, or the gateway returns 400 PROXY_REQUIRED before a browser is started. See Proxy support.

Was this page helpful?