Node.js SDK

All the features and utilities for fast Node.js development with Browserbase.

If you are working with Node.js, the official @browserbasehq/sdk package is the easiest way to connect and act upon headless browsers running on Browserbase.

Installation

Basic usage

Here is an example using the Browserbase Node.js SDK to create and connect to a session using Playwright:

import { chromium } from "playwright-core";
import Browserbase from "@browserbasehq/sdk";

const BROWSERBASE_API_KEY = process.env["BROWSERBASE_API_KEY"]!;
const BROWSERBASE_PROJECT_ID = process.env["BROWSERBASE_PROJECT_ID"]!;

const bb = new Browserbase({
  apiKey: BROWSERBASE_API_KEY,
});

(async () => {
  // Create a new session
  const session = await bb.sessions.create({
    projectId: BROWSERBASE_PROJECT_ID,
  });

  // Connect to the session
  const browser = await chromium.connectOverCDP(session.connectUrl);

  // Getting the default context to ensure the sessions are recorded.
  const defaultContext = browser.contexts()[0];
  const page = defaultContext?.pages()[0];

  await page?.goto("https://browserbase.com/");
  await page?.close();
  await browser.close();
  console.log(
    `Session complete! View replay at https://browserbase.com/sessions/${session.id}`,
  );
})().catch((error) => console.error(error.message));

Examples

Quickstart examples using captcha solving, proxies, extensions, and more

Migration Guide

Guide for migrating from old versions of the Node.js SDK

NPM Package

View the package on NPM

SDK Reference

View the complete SDK reference documentation