The BrowserAI API enables developers to programmatically create, manage, and retrieve results from browser-based automation tasks powered by AI. This API is designed to help you automate web interactions, extract data, scrape, and run scripts in our cloud-based browser environment with customizable geographic targeting. Whether you’re building a data extraction pipeline, automating web testing, or integrating browser automation into your product, this API provides a secure and scalable interface to manage your automation workflows.Documentation Index
Fetch the complete documentation index at: https://docs.browser.ai/llms.txt
Use this file to discover all available pages before exploring further.
Getting Started
- Obtain your API key from the Projects Dashboard.
- Create a task by sending a request to /tasks with your prompt and geo settings.
- Track the task using the
session IDreturned. - Fetch results once the task is completed!
Authentication
All endpoints are secured using an API key. You must include your API key in the Authorization header using the following format:Available Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /tasks | Create a new task. |
| POST | /tasks/{session_id}/command | Force stop a task. |
| GET | /tasks/{session_id} | Get metadata, progress and status of a task. |
| GET | /results/{session_id} | Retrieve the results of a task. |
| POST | /saved_tasks | Create a saved task. |
| GET | /saved_tasks | Get list of saved tasks. |
| GET | /saved_tasks/name/{task_name} | Get a saved task by name. |