00documentation

Orma developer documentation

Orma records what one person actually does — applications and websites used, coding time by project and language, GitHub activity, listening history, health samples, heart rate, locations — and this is how you get it back out.

Everything here reads your own data. There is no endpoint that takes a user id, and none can be added: the server derives the user from the credential and Postgres row-level security filters every query.

Start here
API reference Base URL, authentication, every endpoint, error shapes
OAuth 2.0 The authorization flow, scopes, dynamic client registration
MCP server Connect Claude, ChatGPT or any MCP client to your data
For AI agents When to reach for Orma, and how to call it

Machine-readable

File What it is
https://orma.xeve.io/openapi.json OpenAPI 3.1 description of the API, including security schemes and scopes
https://orma.xeve.io/.well-known/oauth-authorization-server OAuth 2.0 authorization server metadata (RFC 8414)
https://api.xeve.io/.well-known/oauth-protected-resource Protected resource metadata (RFC 9728)
https://orma.xeve.io/.well-known/mcp MCP server manifest: endpoint, transport, auth, capabilities
https://orma.xeve.io/llms.txt What Orma is, when to use it, and every key URL
https://orma.xeve.io/sitemap.xml Every public page

Every page on orma.xeve.io also answers Accept: text/markdown with a Markdown representation of itself, and serves the same document at its .md sibling — https://orma.xeve.io/docs/api.md.

Self-hosting

The backend runs in two containers, app and Postgres. Every URL in these docs is https://api.xeve.io for the hosted service and your own origin for a self-hosted one.

01pages
  • Orma API reference

    The Orma REST API — base URL, bearer token and OAuth authentication, the eleven permission scopes, every endpoint, and the error shapes they return.

  • OAuth 2.0 for the Orma API

    How an application asks a Orma user for scoped access — authorization server metadata, dynamic client registration, PKCE, refresh rotation and revocation.

  • Orma MCP server

    Connect Claude, ChatGPT or any Model Context Protocol client to your own Orma analytics — a hosted Streamable HTTP endpoint with OAuth, or the npm package over stdio.

  • Orma for AI agents

    When an AI agent should reach for Orma, which tool or endpoint answers which question, and how to authenticate — written for agents rather than for people.