Skip to main content
Version: v2

Using your API token

info

Currently, Browserless V2 is available in production via two domains: production-sfo.browserless.io and production-lon.browserless.io

When you sign-up for a Browserless account, we create a unique token that allows you to interact with the service. Once your worker(s) are ready you should use this token anytime you interact with the service.

You can use this token with most of our integrations by simply appending a ?token=YOUR-API-TOKEN as a query-string parameter.

For the purposes of illustrating these examples, we'll assume your API-TOKEN is 094632bb-e326-4c63-b953-82b55700b14c.

Puppeteer with your API Token​

const browser = puppeteer.connect({
  browserWSEndpoint: 'wss://production-sfo.browserless.io?token=094632bb-e326-4c63-b953-82b55700b14c',
});

Playwright with your API Token​

const browser = await playwright.firefox.connect(
  `wss://production-sfo.browserless.io/chromium/playwright?token=094632bb-e326-4c63-b953-82b55700b14c`
);

REST with your API Token​

Query parameter​

The basic way to send your API token over HTTP, is to simply add it as a query parameter:

curl -X POST \
  https://production-sfo.browserless.io/content?token=094632bb-e326-4c63-b953-82b55700b14c \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{ "url": "https://example.com/" }'

Header Authentication​

You can also add an Authorization header for REST API requests as well. Browserless uses the Basic auth scheme to get the token:

warning

As per the HTTP specification, the token must be encoded in base64, otherwise you can get 4XX or 5XX responses.

curl -X POST https://production-sfo.browserless.io/content \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic MDk0NjMyYmItZTMyNi00YzYzLWI5NTMtODJiNTU3MDBiMTRj' \
  -d '{ "url": "https://example.com/" }'