Docs
→
Getting Started
→
Getting Started

Getting Started

Your first steps with HeadlessX

Once you have HeadlessX installed, you can start running automation tasks.

Creating a Profile

Profiles allow you to maintain sessions across different runs. You can create a profile via the API or the Frontend Dashboard.

Via API

curl -X POST http://localhost:3000/api/profiles \
  -H "Content-Type: application/json" \
  -d '{"name": "My First Profile", "user_agent": "Mozilla/5.0..."}'

Running a Scraper

To scrape a Google Search Result Page (SERP):

  1. Navigate to the Playground in the frontend.
  2. Select a Profile.
  3. Enter your Search Query (e.g., "Bestheadless browsers").
  4. Click Run.

HeadlessX will launch a browser, perform the search with human-like interactions, and return the parsed results.

Visual Debugging

You can watch the browser in real-time by enabling headless: false in your configuration or using the live preview feature in the dashboard.