Welcome to Browsepilot API

The Browsepilot API allows you to programmatically control browser automation through AI agents. Start conversations, manage browser profiles, and automate complex web tasks through simple HTTP requests. Base URL: https://browsepilot.ai

Authentication

All Browsepilot API endpoints require authentication using your Workspace ID as an API key.

Finding Your API Key

  1. Open Browsepilot and go to the sidebar
  2. Click Settings (bottom left)
  3. Navigate to Advanced
  4. Copy your Workspace ID - this is your API key

Making Authenticated Requests

Include your API key in the x-api-key header with every request:
curl -X GET "https://browsepilot.ai/api/profiles" \
  -H "x-api-key: your-workspace-id-here" \
  -H "Content-Type: application/json"
Keep your API key secure: Never expose it in client-side code or public repositories. Store it as an environment variable in production.

Rate Limits

  • 100 requests per minute per API key
  • 10 concurrent browser sessions per workspace
  • Requests exceeding limits will return 429 Too Many Requests

Error Handling

All endpoints return consistent error responses:
{
  "error": "Error type",
  "details": "Detailed error message",
  "message": "Human-readable description"
}
Common HTTP status codes:
  • 200 - Success
  • 400 - Bad Request (invalid parameters)
  • 401 - Unauthorized (missing/invalid API key)
  • 404 - Not Found (invalid workspace or resource)
  • 429 - Too Many Requests (rate limit exceeded)
  • 500 - Internal Server Error