Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.browserable.ai/llms.txt

Use this file to discover all available pages before exploring further.

TheSDK uses API keys for authentication. You can obtain your API key from the Browserable Cloud Dashboard or from your local admin dashboard (http://localhost:2001/dash/@admin/settings).

​
Setting Up Authentication

When initializing the SDK, provide your API key in the constructor: 
import { Browserable } from 'browserable-js';

const browserable = new Browserable({
  apiKey: 'your-api-key'
});

​
Custom Base URL

By default, the SDK uses https://api.browserable.ai/api/v1 as the base URL. If you need to use a different base URL (for example, in development or testing), you can specify it in the constructor: 
const browserable = new Browserable({
  apiKey: 'your-api-key',
  baseURL: 'https://custom-api.example.com/api/v1'
});

​
Verifying Authentication

You can verify that your API key is valid by using the check() method: 
try {
  const result = await browserable.check();
  if (result.success) {
    console.log('API key is valid!');
  }
} catch (error) {
  console.error('Failed to validate API key:', error);
}