REST API
REST API Reference
Every HTTP endpoint the gateway exposes, grouped by resource, auto-generated from source.
The gateway exposes three categories of HTTP endpoints:
- Action endpoints (
/v1/screenshot,/v1/content,/v1/scrape): one-shot browser actions, no client code needed. - Control endpoints (
/v1/providers,/v1/config,/v1/profiles,/v1/replays,/v1/sessions,/v1/status): manage the gateway itself. - Compat + dashboard (
/health,/json/version,/web/*): Chrome-compat endpoints and the dashboard.
All /v1/* endpoints require the BG_TOKEN header (or ?token= query param) if BG_TOKEN is set. /health and /json/version are always public.
All endpoints
By resource
- Auth Info: Report whether the gateway requires an auth token.
- Config: Read, validate, and update gateway.yml over HTTP.
- Content: Extract page content (HTML, markdown, or text) from any URL.
- Health: Liveness probe. Always public, no auth required.
- Chrome Compat: Chrome-compatible /json/version endpoint.
- Profiles: Create, export, import, delete stored browser profiles.
- Providers: CRUD for provider entries in gateway.yml.
- Replays: List, fetch, delete session replay frames.
- Scrape: Structured data extraction from a page.
- Screenshot: One-shot screenshot of any URL, no client code required.
- Sessions: Read-only view of active WebSocket sessions.
- Status: Aggregate gateway status (providers, sessions, pool).
- Dashboard: Dashboard static files + login endpoints.