Open the built-in docs page
A single HTML page the API serves itself, built from the OpenAPI spec: a route chooser, a glossary, three quick starts and every endpoint with the mistake people most often make calling it. Useful wherever the API runs without this site.
/docsReturns
stringThe documentation page.
- 503The referenced build artifact has not been built yet.
Every error has the same shape. See Errors for how to handle them.
Show the precise behaviourHide the precise behaviour
An HTML page rendered from this document: an endpoint chooser that starts from the job, the glossary of the identities a response carries, three copy-paste quick starts for a correct map, a defensible trend and a reliable sync, and every operation grouped by task with its most likely refusal. It is read from x-endpoint-chooser, x-glossary, x-quick-starts and each operation's x-likely-refusal, so it cannot describe a route this document does not, and every quick start request is sent as a contract test.