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

# API reference

> Use Qoory's generated OpenAPI reference and client contract.

Qoory uses OpenAPI 3.1 as the source of truth for REST operations,
authentication, scopes, cost extensions, parameters, response schemas, errors,
and examples. The docs site generates endpoint and schema pages directly from
that contract, so Qoory does not maintain a second handwritten field reference.

## Public beta

The generated reference contains every operation available in the public beta.
Each operation uses the same authentication, credit, rate-limit, and response
contracts described in these guides.

## Generated contract

For each available operation, the generated reference defines:

* the HTTP method, path, and base URL;
* required scopes and bearer authentication;
* path, query, and body parameters;
* success and error envelopes;
* credit costs and rate-limit behavior;
* request and response examples.

Generate client types from the OpenAPI document associated with the release you
use. Do not infer a schema from one response example or scrape the rendered HTML.

## Interactive requests

The API playground sends requests directly to Qoory and never requires a docs
proxy. Use a limited-scope test key, avoid placing production credentials in a
shared browser, and revoke any key that may have been exposed.