Skip to main content
The Holos API is a REST API that gives you programmatic access to all platform resources. It’s the same API used by the Holos web dashboard and mobile apps.

​
Base URL

https://api.holos.io

​
Authentication

All requests require a bearer token obtained through the magic link flow. Pass the token in the Authorization header: 
Authorization: Bearer <session_token>
See Authentication for the full token flow.

​
Resources

ResourceDescription
SkillsOrg-scoped tasks that captures are recorded against
CapturesRecorded spatial sessions
Objects3D models used in captures and courses
OrganizationsTenant accounts and member management
UsersUser identity and member profiles

​
OpenAPI spec

A full OpenAPI 3.1 specification is published at /api/openapi.yaml and is automatically synced from the holos-api repository on every master push. Use it to generate client SDKs or explore endpoints interactively.
The OpenAPI spec sync is not yet active. It will be wired up once the spec regeneration pipeline is complete.

​
Concepts

https://mintcdn.com/holosinc/3qjjKOLHhziCZQk_/images/icons/anchor.svg?fit=max&auto=format&n=3qjjKOLHhziCZQk_&q=85&s=17f5ea99b96c4f1d670d7b2c0f45f93f

Authentication

Session tokens and the bearer flow
https://mintcdn.com/holosinc/3qjjKOLHhziCZQk_/images/icons/paths.svg?fit=max&auto=format&n=3qjjKOLHhziCZQk_&q=85&s=00317d8121d44528a8cae26f66a9d8d3

Webhooks

Event notifications via Stytch and Svix
https://mintcdn.com/holosinc/3qjjKOLHhziCZQk_/images/icons/flag.svg?fit=max&auto=format&n=3qjjKOLHhziCZQk_&q=85&s=07cd87f9615b046049e9e045e05812b5

Errors

Error format and status codes