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

# API reference

> How to read the Aquila OpenAPI document and use the playground.

This tab is the generated API reference. Every endpoint, schema, parameter,
and response comes from one OpenAPI document that the API service builds
from its own route table. Nothing in it is hand-maintained.

## Get the document

The service serves the document live:

```
GET https://aquila.attaxr.com/api/openapi.json
```

The same document ships in this repository at `docs/api/openapi.json`. Both
are OpenAPI 3.1. The repository also holds one file per tag under
`docs/api/`. Those files generated the sidebar groups below.

## Authentication in the playground

Each endpoint accepts three alternatives, in this order:

1. `apiKeyCookie` — the `better-auth.session_token` cookie from a browser
   sign-in.
2. `apiKeyHeader` — your `aquila_` key in the `x-api-key` header.
3. `bearerAuth` — your key as a bearer token.

Pick one in the playground's auth panel, or send the header yourself in
curl. See [Authentication](/authentication) for how to get a key.

<Note>
  The playground routes requests through Mintlify servers. Point the examples
  at your own deployment by changing the server dropdown.
</Note>

## Reading the endpoint pages

* **Summaries** come from the route definitions in the service source.
* **Request bodies** render the zod schema the route actually validates
  against. Fields with defaults show as optional.
* **Responses** list every status the handler returns, plus the shared 401,
  403, and 429 the platform adds.
* **Tags** group endpoints by domain: Scans, Leads, Hackbot chat, OOB, and
  so on.