API Reference Overview
rayobrowse exposes HTTP and WebSocket APIs for browser management. The API differs between local mode and cloud mode.
Authentication
Section titled “Authentication”- Local mode: No authentication required (unless in remote mode)
- Cloud mode: Requires
x-api-keyheader ortokenquery parameter - Remote mode: Requires
api_keyquery parameter orX-API-Keyheader
Base URLs
Section titled “Base URLs”| Mode | Base URL |
|---|---|
| Local | http://localhost:9222 (or custom port via RAYOBROWSE_PORT) |
| Cloud | https://cloud.rayobrowse.com |
Error format
Section titled “Error format”API errors return JSON:
{ "error": { "message": "Description of the error", "code": "ERROR_CODE" }}Common HTTP status codes:
| Status | Meaning |
|---|---|
200 | Success |
401 | Invalid or missing API key |
429 | Rate limited or concurrency limit reached |
500 | Internal server error |