Quickstart Guide

Get up and running with Browser Swarm in just a few minutes. This guide walks you through creating your first browser session and interacting with a webpage using our platform.


๐Ÿ“ Step 1: Create an Account

Start by signing up for a free Browser Swarm account. Once registered, you'll have access to the dashboard where you can:

  • Manage your sessions

  • View usage metrics

  • Access your Project ID & API Key


๐Ÿ“ฆ Step 2: Install the SDK (Optional)

Browser Swarm supports multiple languages. Install the SDK for your preferred environment:

Node.js:

npm install browser-swarm-sdk

Python:

pip install browser-swarm

๐Ÿงช Step 3: Launch a Browser Session

You can launch a session using the SDK or directly through our API.

Node.js Example:

import { createSession } from 'browser-swarm-sdk';

const session = await createSession({
  browser: 'chromium',
  headless: true,
  url: 'https://example.com'
});

๐Ÿงญ Step 4: Interact With the Page

Use your automation framework of choice to control the browser session:

await session.page.click('#login');
await session.page.type('#username', 'yourUser');
await session.page.type('#password', 'yourPass');
await session.page.click('#submit');

Supports Playwright, Puppeteer, and Selenium.


๐Ÿ“บ Step 5: Monitor or End Session

You can:

  • Monitor sessions in real time via the dashboard

  • Programmatically end sessions when tasks are complete

await session.close();

โœ… You're Ready!

Youโ€™ve just launched and automated your first headless browser with Browser Swarm. You're now ready to:

  • Use stealth mode and proxies

  • Integrate with AI agents

  • Handle downloads, screenshots, and more

Explore the rest of the documentation to unlock the full power of Browser Swarm.

Last updated