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

# Introduction

> What the Argus API is, who it is for, and how this documentation is organised.

Argus is the operations platform for the UK London Mayfair ER:LC community. It covers dispatch (CAD), officer terminals (MDT), civilian characters and police records (PNC), staff and moderation, and live data from the game server.

This site documents the HTTP API behind the Argus web application, as it is implemented today.

<Warning>
  **This is an internal application API.** It exists to serve the Argus web application and the community's own integrations. It is not a stable public API: there is no versioning, paths and fields can change with any release, and browser requests only work from the application's own origin. Build against it only if you are part of the project.
</Warning>

## What is here

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/authentication">
    Discord sign-in, the session cookie, service credentials and Developer Access.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Make a first authenticated request and read the response envelope.
  </Card>

  <Card title="Permissions" icon="shield" href="/permissions">
    Every permission key, what it allows, and which endpoints check it.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/errors">
    The error envelope, status codes and what a 409 means.
  </Card>
</CardGroup>

The **API reference** tab is generated from an OpenAPI 3.1 document, `api-reference/openapi.json`, kept next to these pages. It lists all 86 implemented operations with their permissions, parameters, request and response shapes, examples and errors.

## API areas

| Area | What it covers | Used by |
| - | - | - |
| Authentication | Discord sign-in, Roblox linking, current user, Developer Access | Everyone |
| CAD | Incidents, units, calls and operational history | Control (dispatchers) |
| MDT | A crew's own unit: book on, join, status, book off | Officers |
| Civilians | A member's own characters, licences and vehicles | Members |
| PNC | Person and vehicle lookup, records, warrants, markers, licence actions | Authorised staff |
| Staff, shifts, sessions | Staff profiles, shifts and roleplay sessions | Staff |
| Moderation and audit | Warnings, kicks, bans and the audit log | Moderators, oversight |
| Administration | Accounts, roles and service credentials | Administrators |
| ER:LC | Live server status and players | Staff |

## Conventions at a glance

* Every path is under `/api` on the deployment's own origin.
* Requests and responses are JSON. Timestamps are UTC, ISO-8601.
* Success responses are wrapped as `{ "data": ... }`, with `meta` on lists. Failures are `{ "error": { "code", "message" }, "requestId" }`.
* Permissions are checked on the server for every request. What the web application shows or hides is never the boundary.

See [API conventions](/api-reference/overview) for the detail, and [API status](/api-status) for what is and is not implemented.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.