Connecting to BrowseAI

Using API Key Authentication

BrowseAI is a web scraping and automation platform that allows you to train robots to extract and monitor data from websites. Authentication is performed using an API key that is sent as a Bearer token in the Authorization header.

The BrowseAI API key has the format {userId}:{apiKey}, where both parts are UUIDs separated by a colon. This full string is provided as a single value in the BrowseAI dashboard.

To obtain your API key:

Log in to your BrowseAI account at https://app.browse.ai
Navigate to Settings in the dashboard
Locate the API section
Copy the full API key string displayed (format: userId:apiKey)

After obtaining your API key, set the following connection properties:

AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

APIKey: Set this to your BrowseAI API key (format: userId:apiKey).

Example Connection String

Profile=C:\profiles\BrowseAI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_user_id:your_api_key";

Connecting to BrowseAI

Once the authentication is configured, you can connect to BrowseAI and query data from any of the available tables such as Robots, RobotTasks, RobotMonitors, and BulkRuns.

Available Tables

The BrowseAI API Profile provides access to the following tables:

BulkRuns: Lists bulk run jobs for a robot (requires RobotId). Bulk runs allow you to execute a robot against multiple URLs or input sets in a single batch operation.
RobotMonitors: Lists the monitors configured for a robot (requires RobotId). Monitors allow robots to run on a schedule and track changes to data on a website over time.
RobotTasks: Lists the individual task runs for a given robot (requires RobotId). Supports filtering by status, bulk run, retried inclusion, and creation date ranges.
Robots: Lists all robots (automated scrapers) configured in your BrowseAI account. Each robot is trained to extract data from a specific website.

Important Notes

Tables that operate in the context of a single robot (RobotTasks, RobotMonitors, BulkRuns) require the RobotId filter to be specified in the WHERE clause.
The RobotTasks endpoint is limited to a maximum page size of 10 items per page. Larger result sets are retrieved through automatic pagination.
Date fields such as CreatedAt, StartedAt, and FinishedAt are returned as Unix timestamps in milliseconds.
If a task's captured data exceeds 100KB, the full payload is only accessible via the CapturedDataTemporaryUrl, which expires after 24 hours.
Rate limiting is enforced at 100 requests per minute per API key. Tasks that do not complete within 15 minutes are terminated with an error.

API Documentation

For more information about the BrowseAI API, see the official BrowseAI API documentation.

Usage Examples

Robots:

SELECT * FROM Robots

Robots (single robot by Id):

SELECT * FROM Robots WHERE Id = 'your-robot-id'

RobotTasks:

SELECT * FROM RobotTasks WHERE RobotId = 'your-robot-id'

RobotTasks (single task by Id):

SELECT * FROM RobotTasks WHERE RobotId = 'your-robot-id' AND Id = 'your-task-id'

RobotTasks (filtered by status):

SELECT * FROM RobotTasks WHERE RobotId = 'your-robot-id' AND Status = 'successful'

RobotMonitors:

SELECT * FROM RobotMonitors WHERE RobotId = 'your-robot-id'

BulkRuns:

SELECT * FROM BulkRuns WHERE RobotId = 'your-robot-id'

BulkRuns (single bulk run by Id):

SELECT * FROM BulkRuns WHERE RobotId = 'your-robot-id' AND Id = 'your-bulk-run-id'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The API key used to authenticate to BrowseAI.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT, OAUTH_PASSWORD