Platform documentation

OpenAPI reference

OpenAPI reference

Elevale publishes an OpenAPI 3.1 specification summarizing endpoints, parameters, and schemas.

Specification URL

  • https://elevale.app/openapi.yaml

  • Relative path on your deployment: /openapi.yaml

The Platform Wiki guides (this folder) are the narrative documentation with examples and security detail. OpenAPI is a concise machine-readable summary-keep both in sync when the API changes.

Document map

  • Introduction to the Elevale API - overview and base URL

  • Reading data (GET API) - query params, filters, and read examples

  • Personal access tokens (PATs) - authentication setup

  • Scopes and permissions - authorization model

  • Requests, responses, and errors - envelopes and rate limits

  • Tasks, KPIs, OKRs, Wiki, BD logs, Chat - per-resource guides