Getting started

This guide takes you from zero to a running browser profile.

From the dashboard, open Profiles and select New profile. Choose an operating system target (win, mac, or linux), a browser version, and an optional proxy. See Profiles for every option.

Launch it

Open the profile from the dashboard, or start it headless through the Local API (POST /sessions/profile). See Launching.

Automate (optional)

Attach an automation framework over CDP using the webSocketDebuggerUrl from the Local API launch response:

automate.ts

import puppeteer from "puppeteer-core";

// Launch via Local API — response includes webSocketDebuggerUrl
const res = await fetch("http://localhost:3000/sessions/profile", {
  method: "POST",
  headers: {
    "X-API-Key": process.env.WORKER_API_KEY!,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ profileId: "my-first-profile" }),
});
const { data } = await res.json();

const browser = await puppeteer.connect({
  browserWSEndpoint: data.webSocketDebuggerUrl,
});
const page = await browser.newPage();
await page.goto("https://example.com");