API Reference
Complete REST API reference for the Hivebrowser platform.
Keep keys in backend services, Workers, or secret managers only.
Set explicit session timeouts and stop browsers when work is complete.
Store session, profile, artifact, and request ids with your jobs.
Base URL
https://api.hivebrowser.aiAuthenticate every request
Use a team API key with bearer authentication. Never expose it in browsers, mobile apps, or client-side logs.
curl -H "Authorization: Bearer hb_your_api_key" \
https://api.hivebrowser.ai/v1/sessionsPick the API by the object you are operating on
The API surface is intentionally small: start browsers, preserve state, collect outputs, secure access, and monitor operations.
Create, list, inspect, preview, and stop managed browser sessions.
Manage durable browser state for login reuse and customer isolation.
Capture screenshots, PDFs, and page content for downstream systems.
Create and disable machine-to-machine credentials for backend services.
Inspect usage, runner health, and team-level runtime settings.
Recommended integration order
Keep the first production integration narrow: prove connection, add state only when needed, then add outputs and operations.
Create a server-side API key and prove one session connection first. Add profiles only when login state or stable context must persist, capture artifacts when a run needs evidence, and monitor runtime consumption, runner health, and team settings after launch.