Browser Swarm Docs
  • ๐Ÿš€Welcome
    • What is Browser Swarm?
  • Understanding Headless Browsers
  • Quickstart Guide
  • Framework Compatibility
  • ๐ŸŒŸ Core Concepts
    • Starting a Browser Task
  • Interacting with Browser Tasks
  • Task Lifecycle Management
  • โš™๏ธAdvanced Features
    • Stealth Automation
  • Proxy Integration
  • Real-Time Monitoring
  • Responsive Viewports
  • Session Debugging & Replay
  • File Handling (Downloads & Uploads)
  • Capturing Screenshots & PDFs
  • Persistent Contexts
  • Extension Support
  • Session Tagging & Metadata
  • ๐ŸŽฏPractical Examples
    • Automating Form Interactions
  • Efficient Data Scraping
  • Automated Web Testing
  • Cost Optimization Strategies
  • Handling Extended Tasks
  • Selecting Execution Regions
  • Monitoring Resource Usage
  • Leveraging Task Metadata
  • Pricing and Subscription
  • Account and Team Management
  • Managing Limits and Concurrency
  • Authentication Automation
  • Security Best Practices
  • ๐Ÿ”ŒEcosystem Integrations
    • Integration Overview
  • ๐Ÿ’ปDeveloper Resources
    • APIs and SDKs Overview
  • Node.js Integration
  • Python Integration
  • Browser Task API
  • Project Management API
  • Context Management API
  • Browser Extensions API
  • ๐Ÿ™‹โ€โ™‚๏ธSupport & Resources
    • Getting Help
  • Dashboard Overview
  • FAQs & Troubleshooting
Powered by GitBook
On this page
  • ๐Ÿ“ Step 1: Create an Account
  • ๐Ÿ“ฆ Step 2: Install the SDK (Optional)
  • ๐Ÿงช Step 3: Launch a Browser Session
  • ๐Ÿงญ Step 4: Interact With the Page
  • ๐Ÿ“บ Step 5: Monitor or End Session
  • โœ… You're Ready!

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.

PreviousUnderstanding Headless BrowsersNextFramework Compatibility

Last updated 1 month ago