API Overview

This page used to host hand-maintained endpoint tables and protocol details that drifted from the code. That content has moved to two living docs:

• API conventions — URL shape, request/response patterns, status codes, error format, pagination, idempotency, OpenAPI client generation, public endpoints.
• Authentication & permissions — JWT issuance and validation, OAuth providers (GitHub / Google / Microsoft), API tokens (aexy_…), workspaces, RBAC, public share tokens.

For per-module endpoint lists, see the module docs — each one cites the actual file + endpoint paths from the codebase. Start at the docs index.

Base URL#

Local dev      http://localhost:8000/api/v1
Production     https://server.aexy.io/api/v1   # (or your BACKEND_URL + /api/v1)

Every route is mounted under /api/v1. There is no /api/v2.

Live API documentation#

The backend serves its own OpenAPI schema and human-readable docs:

• GET /docs — Swagger UI
• GET /redoc — ReDoc
• GET /openapi.json — raw schema (used by the frontend codegen at frontend/src/lib/api.ts)

These reflect the running code, so they are always more authoritative than any hand-written endpoint table.

Quick reference#