Overview

BrowserBee exposes a focused HTTP API for browser profiles, API tokens, webhooks, and operational checks. This site is organized so teams can move from orientation to implementation without guessing where information lives.

Use this site to:

• understand the BrowserBee platform model before writing code
• choose the right guide for your immediate task
• learn the API conventions that apply across the platform
• generate and manage API tokens safely
• make your first BrowserBee API call with confidence
• build integrations with raw HTTP or generated clients

BrowserBee endpoints

Endpoint	URL
App	app.browserbee.com
API	https://api.browserbee.com/api/v1
Development API	https://api-dev.browserbee.com/api/v1
Developer docs	developers.browserbee.com
API Reference	developers.browserbee.com/reference

How this site is organized

Overview

Use Overview when you want the big picture:

• what BrowserBee exposes
• how environments are separated
• which workflows are typical for new integrations
• which documentation section to open next

Guides

Use Guides when you want step-by-step outcomes such as:

• making your first API request
• creating a browser profile
• managing tokens by environment
• choosing between raw HTTP and generated clients
• preparing retries and handling rate limits

Documentation

Use Documentation when you need durable reference material:

• BrowserBee API fundamentals
• methods and parameters
• authentication details
• SDK and OpenAPI guidance
• webhook concepts and integration notes

API Reference

Use API Reference when you need endpoint-by-endpoint details, schemas, and concrete request examples.

Recommended reading order

1. Read Platform concepts to understand BrowserBee resources and environments.
2. Follow Quick Start to generate a token and make a working request.
3. Review The basics and API structure.
4. Choose a practical guide such as Create your first browser profile.
5. Keep API Reference open as you implement.

Common tasks

• Need to generate an API key? Go to Authentication.
• Need to install tooling for a language client? Go to SDKs.
• Need to make your first request? Go to Quick Start.
• Need to understand BrowserBee resources? Go to Platform concepts.
• Need to understand limits and error handling? Go to API limits and Errors.
• Need endpoint-by-endpoint details? Go to API Reference.

Recommended first workflow

If you are integrating BrowserBee for the first time, use this order:

1. Create a token for your environment.
2. Call GET /browsers to verify connectivity and credentials.
3. Call one single-resource endpoint such as GET /browsers/\{profile_key\}.
4. Decide whether to use raw HTTP requests or a generated client library.
5. Keep the API Reference open while you build.

First authenticated request

export BROWSERBEE_BASE_URL="https://api.browserbee.com/api/v1"
export BROWSERBEE_API_TOKEN="<YOUR_TOKEN>"

curl --request GET "${BROWSERBEE_BASE_URL}/browsers" \
  --header "Authorization: Bearer ${BROWSERBEE_API_TOKEN}" \
  --header "Accept: application/json"

Next steps

• Continue to Platform concepts.
• Make a full working request in Quick Start.
• Review Connecting to the API.
• Move to SDKs once your first request succeeds.