Skip to content
DashboardWebsite

Endpoints Reference

This reference lists REST endpoints for engineers and platform administrators. The docs build renders the endpoint pages from the OpenAPI schema committed in OpenTremor-core/docs/openapi.json. A running instance serves its schema at /v1/openapi.json and an interactive API view at /v1/docs.

Each endpoint page lists the route, its purpose and access requirements, parameters, request and response bodies, examples, and error statuses.

  • Authentication. Pass an API key in the X-API-Key header, or sign in to get a session cookie. See Set Up Authentication.
  • Validation errors. Every route returns 422 when the request does not match its schema. The generated pages omit that status.
  • Examples. Generated examples use placeholders such as "string" and omit fields whose values are null.