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

# Introduction

> Interact programmatically with your Bookeeping.ai account using direct HTTP requests.

## Regions

We have three regions available. And you have to choose the one which your account is created in.

| Region Name           | Base URL                                  |
| --------------------- | ----------------------------------------- |
| US East (N. Virginia) | `https://api.bookeeping.ai/public-api`    |
| Europe (Belgium)      | `https://eu-api.bookeeping.ai/public-api` |
| Canada (Toronto)      | `https://ca-api.bookeeping.ai/public-api` |

## Authentication

All API endpoints are authenticated using Bearer tokens to create your tokens follow the steps below:

1. Navigate to your bookeeping.ai dashboard.
2. Click **Settings** in the sidebar.
3. Select the **API Access** tab.
4. Create a new token by clicking the **Create API Key** button.

## Rate Limits

The Bookeeping.ai API enforces rate limits to ensure fair usage and maintain optimal performance for all users. If you exceed this limit, you will receive a `429 Too Many Requests` response. To avoid hitting the rate limit, consider implementing exponential backoff or request throttling in your application.

### Default Rate Limits

| Endpoint Type             | Rate Limit                                     |
| ------------------------- | ---------------------------------------------- |
| Read Operations           | 100 requests per minute, 6000 requests per day |
| Write / Delete Operations | 25 requests per minute, 1500 requests per day  |

### Rate Limit Headers

| Header Name                     | Description                                                   |
| ------------------------------- | ------------------------------------------------------------- |
| `x-rate-limiter-daily-limit`    | Maximum number of requests allowed per day. Example: `1500`.  |
| `x-rate-limiter-minutely-limit` | Maximum number of requests allowed per minute. Example: `25`. |
| `x-rate-limiter-daily-usage`    | Number of requests made today. Example: `106`.                |
| `x-rate-limiter-minutely-usage` | Number of requests made in the current minute. Example: `1`.  |
| `x-rate-limiter-operation-type` | Operation type for the endpoint: either `read` or `write`.    |

Contact us if you require higher rate limits for your application.
