# API

HTTP endpoint reference for the Omazy CX middleware.

Source: https://docs.omazy.ai/reference/api/

The API is served at `https://mw.omazy.ai/api/v1`.

:::caution[This reference covers 54 of about 725 endpoints]
The endpoint reference is generated from the middleware's OpenAPI spec, and the
spec only contains what has been annotated. Right now that is **54 operations
across 43 paths**, out of roughly **725 registered routes**.

So: everything documented here is real and current. But an endpoint missing from
this page is far more likely to exist and work than not to exist. Absence is
evidence of an unwritten annotation, not of a missing feature.

If you need one that is not here, ask. Annotating a route is a small change and
we would rather do it than have you guess.
:::

## Where things are

| | |
|---|---|
| [Authentication](/reference/api/authentication/) | Tokens, scoping, revocation |
| [Conventions](/reference/api/conventions/) | Envelope, pagination, rate limits, idempotency |
| **Endpoints** | The generated reference, in the sidebar under this section |

## Response envelope

Every response uses the same shape, so a client can handle success and failure
in one place.

```json
{
  "success": true,
  "data": { },
  "meta": { }
}
```

On failure, `success` is `false` and the payload carries a stable error code.
Codes are listed in [Platform](/reference/platform/).

## Authentication

Requests carry a bearer token scoped to an install. Tokens are minted per
machine, so revoking one does not sign out the rest.

## Coming in this section

The generated endpoint reference, pagination, rate limits, and idempotency.