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

# API reference

> Every route of Lekalao's REST API, with a playground.

This reference is generated from Lekalao's OpenAPI document. Each page describes one route: parameters, body, answers, and examples in `curl`, JavaScript, PHP and Python.

## Try it

The **Try it** button on each page sends a real call:

1. In **Server**, replace `lekalao.example.com` with the address of your own Lekalao.
2. In **Authorization**, paste a token (**Settings → API tokens**).

<Warning>
  The playground acts on your real data. Use a test team, or a **Read** token,
  to explore.
</Warning>

## In short

|                |                                                                                    |
| -------------- | ---------------------------------------------------------------------------------- |
| Address        | `https://your-lekalao/api/v1`                                                      |
| Authentication | `Authorization: Bearer <token>`. See [Authentication](/developers/authentication). |
| Format         | JSON; `Accept: application/json`.                                                  |
| Identifiers    | `id`, a uuid.                                                                      |
| Pagination     | `page`, `per_page` (100 at most); `links` and `meta` in the answer.                |
| Rate limit     | 120 calls a minute per token.                                                      |
| Idempotency    | The `Idempotency-Key` header on writes, for 24 hours.                              |

The detail is in [Conventions](/developers/conventions) and [Errors](/developers/errors).

## The OpenAPI document

Every installation serves its own, up to date with its version:

```bash theme={null}
curl https://lekalao.example.com/api/v1/openapi.json -o lekalao-openapi.json
```

Import it into Postman or Insomnia, or generate a client:

```bash theme={null}
npx @openapitools/openapi-generator-cli generate \
  -i lekalao-openapi.json -g typescript-fetch -o ./lekalao-client
```

The document published here is written out in full and more detailed; the one from the installation follows its routes exactly.