↓ Skip to main content
BrowserBee
  1. Documentation/
  2. Getting started/

Quickstart

Create your first BrowserBee token, list available browser profiles, and register a profile in minutes.

Before you begin
#

Make sure you have:

  • your BrowserBee account email and password
  • network access to the BrowserBee API
  • a terminal with curl available

BrowserBee currently publishes these API base URLs:

  • Production: https://api.browserbee.com/api/v1
  • Development: https://api-dev.browserbee.com/api/v1

Step 1: Create an API token
#

Token creation uses HTTP Basic authentication. The plaintext token is returned once, so store it in your password manager or secrets vault immediately.

curl --request POST "https://api.browserbee.com/api/v1/tokens" \
  --user "you@example.com:YOUR_PASSWORD" \
  --header "Content-Type: application/json" \
  --data '{
    "token": {
      "name": "quickstart"
    }
  }'

Successful responses include the token value, prefix, and creation timestamp.

Step 2: Verify API access
#

Use the token as a Bearer token for normal API operations.

export BROWSERBEE_API_TOKEN="tok_your_value_here"

curl --request GET "https://api.browserbee.com/api/v1/browsers" \
  --header "Authorization: Bearer ${BROWSERBEE_API_TOKEN}" \
  --header "Accept: application/json"

If the request succeeds, your integration is ready for profile operations.

Step 3: Register a browser profile
#

BrowserBee profiles are keyed resources that describe the browser, channel, version, supported capabilities, platforms, and runtime defaults.

curl --request POST "https://api.browserbee.com/api/v1/browsers" \
  --header "Authorization: Bearer ${BROWSERBEE_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{
    "profile_key": "chrome-stable-linux",
    "name": "Chrome Stable on Linux",
    "channel": "stable",
    "version": "136",
    "status": "available",
    "capabilities": ["webdriver", "screenshots"],
    "platforms": ["linux"],
    "configuration": {
      "timeout_seconds": 90,
      "retry_attempts": 2,
      "headless": true,
      "viewport": {
        "width": 1440,
        "height": 900
      }
    }
  }'

Step 4: Register a webhook
#

Webhooks let you react when profiles are created, updated, activated, deprecated, or deleted.

curl --request POST "https://api.browserbee.com/api/v1/webhooks" \
  --header "Authorization: Bearer ${BROWSERBEE_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{
    "webhook": {
      "url": "https://example.com/browserbee/events",
      "events": [
        "browser_profile.created",
        "browser_profile.updated",
        "browser_profile.deprecated"
      ]
    }
  }'

BrowserBee returns the webhook signing secret once. Store it alongside the token.

What to do next
#