Quickstart

import { BrowserTest } from 'browsertest-sdk';

// Initialize the SDK
const bt = new BrowserTest({
  apiKey: process.env.BROWSERTEST_API_KEY // Use environment variable
});

// Take your first screenshot
async function main() {
  try {
    const screenshot = await bt.screenshot.take({
      url: 'https://example.com',
      fullPage: true,
      format: 'png'
    });

    console.log('Screenshot captured!');
    console.log('Size:', screenshot.data.screenshot.length, 'bytes');
    console.log('Dimensions:', `${screenshot.data.width}x${screenshot.data.height}`);

  } catch (error) {
    console.error('Error:', error.message);
  }
}

main();

import { BrowserTest } from 'browsertest-sdk';

const bt = new BrowserTest({
  apiKey: process.env.BROWSERTEST_API_KEY
});

async function testConnection() {
  try {
    // Test connection
    const isConnected = await bt.testConnection();
    console.log('API Connection:', isConnected ? '✅ OK' : '❌ Failed');

    // Check usage
    const usage = await bt.getUsage();
    console.log('Plan:', usage.plan);
    console.log('Screenshots remaining:', usage.usage.screenshot.remaining);
    console.log('Tests remaining:', usage.usage.agentic.remaining);

  } catch (error) {
    console.error('Setup test failed:', error.message);
  }
}

testConnection();

your-project/
├── src/
│   ├── services/
│   │   └── browserTest.js     # SDK wrapper/service
│   ├── tests/
│   │   ├── visual-regression.js
│   │   └── e2e-tests.js
│   └── utils/
│       └── screenshot-helpers.js
├── .env                       # API key (don't commit!)
└── package.json

// src/services/browserTest.js
import { BrowserTest } from 'browsertest-sdk';

const bt = new BrowserTest({
  apiKey: process.env.BROWSERTEST_API_KEY,
  timeout: 30000,
  retries: 3
});

export default bt;