Skip to content

API Reference Overview

rayobrowse exposes HTTP and WebSocket APIs for browser management. The API differs between local mode and cloud mode.

  • Local mode: No authentication required (unless in remote mode)
  • Cloud mode: Requires x-api-key header or token query parameter
  • Remote mode: Requires api_key query parameter or X-API-Key header
ModeBase URL
Localhttp://localhost:9222 (or custom port via RAYOBROWSE_PORT)
Cloudhttps://cloud.rayobrowse.com

API errors return JSON:

{
"error": {
"message": "Description of the error",
"code": "ERROR_CODE"
}
}

Common HTTP status codes:

StatusMeaning
200Success
401Invalid or missing API key
429Rate limited or concurrency limit reached
500Internal server error