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

# Introduction

> Boxpilote Public API Reference

<Note>
  A valid Boxpilote account is mandatory to access and utilize this API. If you don't already have an account, please contact Boxpilote support to request access.
</Note>

## Welcome

The Boxpilote API allows users to automate business processes and manage their data: opportunities, quotes, surfaces, rentals, insurances, services, products, and VAT rates. This reference uses the OpenAPI specification to document available endpoints, authentication, and usage.

**Base URL:** `https://api.boxpilote.fr`

<CardGroup cols={2}>
  <Card title="Opportunities" icon="building" href="/api-reference/endpoint/opportunities/create">
    Create business opportunities
  </Card>

  <Card title="Quotes" icon="file-invoice" href="/api-reference/endpoint/quotes/get">
    List all quotes
  </Card>

  <Card title="Create quote" icon="file-invoice-dollar" href="/api-reference/endpoint/quotes/create">
    Create a new quote
  </Card>

  <Card title="Quote by ID" icon="file-invoice-dollar" href="/api-reference/endpoint/quotes/get-by-id">
    Get quote by ID
  </Card>

  <Card title="Surfaces" icon="layer-group" href="/api-reference/endpoint/surfaces/get">
    List surfaces
  </Card>

  <Card title="Rentals" icon="key" href="/api-reference/endpoint/rentals/get">
    List rentals
  </Card>

  <Card title="Insurances" icon="shield-halved" href="/api-reference/endpoint/insurances/get">
    List insurances
  </Card>

  <Card title="Services" icon="wrench" href="/api-reference/endpoint/services/get">
    List services
  </Card>

  <Card title="Products" icon="box" href="/api-reference/endpoint/products/get">
    List products
  </Card>

  <Card title="VAT Rates" icon="percent" href="/api-reference/endpoint/vat-rates/get">
    List VAT rates
  </Card>
</CardGroup>

## Authentication

All API endpoints are secured via Bearer tokens, as specified in the OpenAPI file

```json theme={null}
"headers": [
  {
    "Authorization": Bearer <your_token_here>
  }
]
```

## Rate Limiting

The API enforces **throttling**: max 500 requests per second per API key.

### When exceeded

If you exceed the limit, the API returns **429 (Too Many Requests)** with:

> Rate limit exceeded (N requests per second).