API Reference Overview

Full specifications for every Browserless endpoint. Use these references to look up exact parameters, types, and response shapes.

BrowserQL schema

Complete GraphQL schema for BrowserQL. Covers every mutation (goto, click, type, solve, html, and more), input types, and response types.

OpenAPI reference

OpenAPI specification for every Browserless endpoint: REST HTTP methods, WebSocket connections for Puppeteer/Playwright/CDP clients, and Browserless-specific CDP extensions.

Browserless CLI

Command reference for @browserless.io/cli. Capture authenticated profiles, manage cloud profiles, configure regions, and interact with the hosted agent.

FAQ & Troubleshooting

How do I authenticate API requests?

Pass your API token as a ?token= query parameter in the request URL. Some endpoints also accept it in the Authorization header.

Where can I test API endpoints?

Use the API playground to test endpoints interactively with your token.

Next steps

REST API endpoints

all available REST API routes

API playground

test endpoints interactively