For AI agents: a documentation index is available at /llms.txt
Skip to main content
Version: 2.54.2

OpenAPI Reference Overview

This is the API reference for Browserless Enterprise and Cloud deployments. You'll find endpoints for capturing screenshots and PDFs, scraping content, running custom browser functions, solving CAPTCHAs, bypassing bot detection with stealth browsing, managing authenticated browser profiles, and orchestrating crawls.

The API includes REST endpoints (JSON in, JSON or binary out), WebSocket connections for direct CDP/Playwright/Puppeteer access, and CDP extensions that expose Browserless-specific commands like liveURL, solveCaptcha, and saveProfile. For the open-source container API, see the GitHub repository.

Endpoint Categories​

Core APIs

Screenshots, PDFs, content scraping, and custom Puppeteer/Playwright functions.

Browser Control

Sessions and connections, browser management, and multi-page crawl jobs.

Anti-Bot & Stealth

Bypass bot detection end-to-end, or route sessions through residential and datacenter proxies.

Auth & Profiles

Persistent authenticated browser profiles and 1Password credential integrations.

WebSocket / CDP

Connect Puppeteer, Playwright, or raw CDP clients, plus Browserless-specific CDP extensions like liveURL and solveCaptcha.

Chrome

Licensed Chrome build for DRM/codec-dependent sites and enhanced bot-detection evasion.

Just Getting Started?​

Check out the Quick Start guide to launch your first session, or explore the BrowserQL IDE for a GraphQL-based automation workflow.

Base URL​

All API requests go to your deployment's base URL. For Browserless Cloud:

https://production-sfo.browserless.io

Self-hosted Enterprise deployments use the host and port where the container is running (default http://localhost:3000).

Authentication​

Include your API token as a query parameter on every request:

https://production-sfo.browserless.io/chromium/content?token=YOUR_API_TOKEN

Tokens are managed from the Account dashboard. Self-hosted deployments set the token via the TOKEN environment variable. See connection details for all authentication options.

Changelog​

For release notes and version history, see the Enterprise Changelog.

Software keys​

Self-hosted Enterprise deployments use time-limited software keys for offline licensing. No external connections or callbacks are required. Keys are cryptographically secure and can't be reverse engineered. When a key expires, the container exits with a semantic error code.

To use a software key, set the KEY environment variable when running the container:

docker run -e KEY=your-generated-key browserless/enterprise