System Architecture
Core Features
Data Management
Frontend Components
Extensibility
The following files were used as context for generating this wiki page:
This document outlines the various operational endpoints exposed by the API, covering browser automation, device agent management, device listing, and health checks. These endpoints facilitate interaction with external services like Browserbase HQ and internal device management systems, providing functionalities ranging from automated browser tasks to device monitoring and agent distribution.
The API is structured using NestJS controllers and services, with authentication handled by HybridAuthGuard and organization context managed via X-Organization-Id headers or API keys.
The Browser Automation endpoints provide a comprehensive interface for managing and executing automated browser tasks using Browserbase HQ. This includes managing organization-specific browser contexts, controlling browser sessions, performing navigation, and handling the lifecycle of browser automations and their execution runs.
The BrowserbaseController exposes the API endpoints, which delegate business logic to the BrowserbaseService. The service interacts with the @browserbasehq/sdk and @browserbasehq/stagehand libraries, as well as an S3 client for screenshot storage and a Prisma client (@trycompai/db) for persistence of automation configurations and run history.
A Browserbase context represents a persistent browser environment for an organization. It allows sessions to share cookies, local storage, and other browser data, enabling consistent authentication and state across multiple automation runs.
The BrowserbaseController (/browserbase) provides the following endpoints: