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

# API reference

> Base URLs, authentication, headers and errors shared by every Partner API route.

The Partner API is the API of approved partner applications, such as logbooks, that act for a pilot who has granted them access on the MyPilotIndex consent screen. Partner routes live under `/v1/partner/` and are never served to browsers.

## Base URLs

| Environment | Host |
| - | - |
| Sandbox | Issued to the partner with its sandbox credential, on the AWS dev environment, with synthetic pilots. |
| Production | Announced at launch. |

## Authentication

Authenticate with an access token from the identity provider's token endpoint (`grant_type=client_credentials`, scopes `partner/<scope>`) in the `Authorization` header. See [Authentication](https://developers.mypilotindex.com/authentication.md).

```http theme={null}
Authorization: Bearer <access_token>
```

To try a route in the playground, paste a sandbox access token in its authorization field.

## Rate limit headers

Every authenticated answer carries `X-RateLimit-Limit` and `X-RateLimit-Remaining`, the partner's daily allowance and what is left of it. A `401`, and a path or method outside this API, carry neither. Past the allowance the API answers `429 rate_limited` with `Retry-After`. See [Rate limits](https://developers.mypilotindex.com/rate-limits.md).

## Errors

Errors use one shared envelope with a stable `code`, a safe `message`, a `correlation_id` and an optional `reason`. See [Errors](https://developers.mypilotindex.com/errors.md).

## Versioning

The API is additive within v1: new fields and routes may appear, existing ones do not change meaning. See the [changelog](https://developers.mypilotindex.com/changelog.md).

## The OpenAPI document

The reference is generated from the Partner API's OpenAPI 3.1 document. Download it from the menu at the top of any endpoint page to generate a client.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.