Skip to main content

Quick Start

This guide is the fastest path from a new BrowserBee account to a successful API call against the BrowserBee API.

Before you begin​

  • A BrowserBee account at app.browserbee.com
  • Access to the environment you intend to use first:
    • production: https://api.browserbee.com/api/v1
    • development: https://api-dev.browserbee.com/api/v1
  • A terminal or API client such as curl, Postman, Insomnia, or Bruno

1. Create your account​

If you are new to BrowserBee:

  1. Sign in to app.browserbee.com.
  2. Confirm which workspace or environment you should use first.
  3. Decide whether you are testing locally, staging an integration, or preparing production automation.

That decision affects which base URL and token you should use.

2. Generate your API token​

Open Settings -> API Tokens in the BrowserBee app and create a token for the environment you are using.

Recommended defaults:

  • one token per workload or application
  • one token per environment
  • clear names such as local-dev, staging-sync, or production-worker
  • immediate secure storage after creation because tokens should be treated like passwords

More detail is available in Authentication and Manage API tokens.

3. Set your base URL​

https://api.browserbee.com/api/v1

If you are working against the development environment instead, use:

https://api-dev.browserbee.com/api/v1

4. Export environment variables​

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

If you use a local .env file, make sure it is ignored by Git and scoped to the correct environment.

5. Make your first API call​

Use GET /browsers to confirm that:

  • your token is valid
  • your base URL is correct
  • your network path to BrowserBee is working
  • BrowserBee returns structured JSON successfully
curl --silent \
  --request GET \
  --header "Authorization: Bearer ${BROWSERBEE_API_TOKEN}" \
  --header "Accept: application/json" \
  "${BROWSERBEE_BASE_URL}/browsers"

6. Confirm the response shape​

On success you should receive JSON. The exact fields depend on the endpoint and your environment state, but the important first milestone is that:

  • the request is authenticated
  • the response is machine-readable
  • your integration path is proven end to end

If you receive an error instead:

  1. confirm the token belongs to the same environment as the base URL
  2. confirm the Authorization: Bearer header is present
  3. confirm the token has not been revoked or copied incorrectly
  4. review Connecting to the API
  5. review Errors

7. Make one targeted follow-up request​

After GET /browsers succeeds, make one focused request such as:

  • reading a single profile by key
  • listing profiles again with query parameters
  • moving from manual curl to an SDK or generated client

This second request helps you verify how your application will handle resource-specific paths and parameters.

8. Decide how you want to integrate​

At this point most teams choose one of two paths:

  1. Raw HTTP for simple scripting, internal tools, and direct API exploration.
  2. Generated or wrapped clients for shared services, typed integrations, and repeatable automation.

Use SDKs and OpenAPI when you are ready to standardize how your codebase talks to BrowserBee.

Next steps​

Open the live API reference:

developers.browserbee.com/reference