Browserbase compatibility

Already written against the Browserbase SDK? Change the import and the key. Sessions, contexts, live view and recording work the same way, and anything Solari can't do raises a clear error instead of silently doing something different.

Install

npm install @solarisdk/browserbase-compat
pip install solari-browserbase-compat

Use it

import Browserbase from "@solarisdk/browserbase-compat"
import { chromium } from "playwright-core"

const bb = new Browserbase({ apiKey: process.env.SOLARI_API_KEY }) // slr_… key
const session = await bb.sessions.create()
const browser = await chromium.connectOverCDP(session.connectUrl)
const page = browser.contexts()[0].pages()[0] ?? (await browser.contexts()[0].newPage())
await page.goto("https://example.com")
await browser.close()
await bb.sessions.update(session.id, { status: "REQUEST_RELEASE" })

import os
from solari_browserbase import Browserbase
from playwright.sync_api import sync_playwright

bb = Browserbase(api_key=os.environ["SOLARI_API_KEY"])  # slr_… key
session = bb.sessions.create()
with sync_playwright() as p:
    browser = p.chromium.connect_over_cdp(session.connect_url)
    page = browser.contexts[0].pages[0] if browser.contexts[0].pages else browser.contexts[0].new_page()
    page.goto("https://example.com")
    browser.close()
bb.sessions.update(session.id, status="REQUEST_RELEASE")

connectUrl is a plain Chrome DevTools Protocol URL, so Playwright, Puppeteer, Stagehand and browser-use all connect, and there is no client version to pin. Keep the URL private: the session id inside it is the credential.

Use a Solari key

Only keys that start with slr_ are used. A Browserbase key in BROWSERBASE_API_KEY is skipped, never sent anywhere, and never printed.

What works

Browserbase	On Solari
`sessions.create / retrieve / list / update`	Yes. `REQUEST_RELEASE` releases the session; statuses map to `RUNNING`, `COMPLETED`, `TIMED_OUT`, `ERROR`.
`connectUrl`	A raw CDP websocket URL.
`proxies: true`, `geolocation`	A managed proxy in the country, state or city you pick. It runs on the stealth browser, which is switched on for you.
`verified`, `advancedStealth`	The stealth browser.
`solveCaptchas: true`	Captcha solving. Off unless you pass `true` (Browserbase turns it on by default).
`recordSession: true`	Session recording, off unless you pass `true`. Read it back with `sessions.recording.retrieve`.
`allowedDomains`	Egress allowlist (enterprise plan).
Contexts	Saved as Solari profiles: cookies and localStorage.
`sessions.debug`	A view-only live-view link.

What is different

Recording is a DOM-event log, not video. sessions.recording.retrieve returns the events a few seconds after you release the session. There is no HLS or MP4.
Contexts keep cookies and localStorage, not IndexedDB or service workers.
Disconnects. A session whose connection drops is released about 45 seconds later, so reconnect inside that window. Sessions end at your plan's maximum session length.
No effect, with a warning: timeout, keepAlive, userMetadata, viewport, blockAds, logSession and os. Pass strict: true to make them errors.

Contexts

const ctx = await bb.contexts.create({ name: "shop-login" })
const s = await bb.sessions.create({
  browserSettings: { context: { id: ctx.id, persist: true } },
})
// …log in, then release through the same client to save it:
await bb.sessions.update(s.id, { status: "REQUEST_RELEASE" })

// Next time, the saved login comes back as storageState:
const s2 = await bb.sessions.create({ browserSettings: { context: { id: ctx.id } } })
const browser = await chromium.connectOverCDP(s2.connectUrl)
const page = await (await browser.newContext({ storageState: s2.storageState })).newPage()

Solari applies a saved context to a browser context created with it, so use newContext({ storageState }) rather than the default context.

Not supported

These raise SolariCompatUnsupported: browser extensions, the Selenium endpoint, the downloads and uploads APIs, video replays, session logs, bring-your-own proxies, per-domain proxy rules, custom CA certificates, ignoreCertificateErrors, custom captcha selectors, mobile and tablet profiles, regions other than us-west-2, metadata queries, and the separate Projects, Agents, Fetch and Search products.

The full list, with every difference, is in each package's COMPAT.md.