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

# API reference overview

> How the Arbol REST reference is generated and how to use the production OpenAPI contract.

The endpoint reference is generated directly from the live document at [`https://api.getarbol.com/openapi.json`](https://api.getarbol.com/openapi.json).

The contract defines:

* the production server URL and base path;
* request path, query, and JSON body schemas;
* success and error response schemas;
* user and machine authentication alternatives; and
* exact permissions for each operation.

## Source of truth

Use the generated endpoint page for operation-specific limits and behavior. Handwritten guides explain cross-cutting patterns but do not replace the schema.

<Note>
  The API repository generates OpenAPI from the same implemented router that serves REST requests. Only operations explicitly marked for publication enter this document.
</Note>

## Request conventions

* Send JSON request bodies with `Content-Type: application/json`.
* Send bearer credentials in the `Authorization` header.
* Use the production URL from the document's `servers` array.
* Record the `X-Request-Id` response header for support and incident correlation.
* Encode arrays and objects exactly as described by each query parameter's OpenAPI `style` and `explode` values.

The interactive playground sends requests directly to the API rather than through a documentation proxy. Browser calls are therefore subject to the API's published CORS policy.

## Keeping generated pages current

Because changing a remote OpenAPI document does not create a commit in this repository, the API deployment workflow must call Mintlify's Trigger deployment API after the new document is reachable in production.