> ## Documentation Index
> Fetch the complete documentation index at: https://docs.browsepilot.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Integrate Browsepilot AI browser agent into your applications with our REST API

## 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`

<CardGroup cols={2}>
  <Card title="Start Conversations" icon="comments" href="/api-reference/endpoint/create">
    Create new AI-powered browser automation sessions
  </Card>

  <Card title="Manage Profiles" icon="user" href="/api-reference/endpoint/get">
    Retrieve and manage your browser profiles
  </Card>
</CardGroup>

## 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:

```bash theme={null}
curl -X GET "https://browsepilot.ai/api/profiles" \
  -H "x-api-key: your-workspace-id-here" \
  -H "Content-Type: application/json"
```

<Warning>
  **Keep your API key secure**: Never expose it in client-side code or public
  repositories. Store it as an environment variable in production.
</Warning>

## 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:

```json theme={null}
{
  "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