Agent-readable docs index: /docs/llms.txt. Full docs in one file: /docs/llms-full.txt. Download /docs/docs.zip to grep all markdown files locally.

API overview

RailDock exposes an HTTP API under /api. The current API is not version-prefixed, so clients should pin the RailDock release they test against and treat the interactive reference as release-coupled documentation.

Base URL

For a RailDock host at https://raildock.example.com, the API base is:
https://raildock.example.com/api

Health check

curl https://raildock.example.com/api/health
The health endpoint returns status and server time.

Authentication

Most control-plane endpoints require a bearer JWT. Read Authentication.

Interactive reference

Open the Scalar API Reference for endpoint discovery, schema inspection, and request examples.
The supplied OpenAPI document is a website/reference companion derived from the current route/controller research. Because the repository does not currently ship a canonical OpenAPI file, validate request bodies and responses against the RailDock release you deploy before generating a strict production SDK.