Skip to content

API reference

The OLS REST API is contract-first: its surface is defined by an OpenAPI specification generated from the backend (per the API contract pipeline).

The interactive reference — an embedded Scalar console that reads the OpenAPI specification and lets you try requests in the browser — is wired in a later documentation chunk. Until then, the OpenAPI specification itself is the authoritative description of every endpoint, request body, and response shape.