Magicians VR4Deaf Platform — API Documentation

OpenAPI definition and aggregated documentation for the Magicians VR4Deaf Platform internal and public API, rendered with Redocly.

Project Docs

See the docs/ directory for full project documentation:

Ecosystem Guides

• About 360Magicians
• Infrastructure / Ecosystem Architecture
• Git Workflow & GitHub Integration
• Helm Deployment (dev → prod)
• Environments & Bootstrap
• AI Providers, Vendors & Resources
• AI Model Manifest
• AI Inference Architecture
• Package Managers & Runtimes
• Triggers, Webhooks & Prompts
• Pipeline Handoffs
• Copilot, Bots & Auth Access

Project Docs

• DeafAuth
• PinkSync
• FibonRose
• Municipal DAO
• Railway Next.js Template
• MBTQ.dev
• MBTQUniverse

Base URLs

Environment	URL
Public API gateway	https://magicians.vr4deaf.org/api/v1
Internal (service-to-service, cluster only)	https://internal.magicians.vr4deaf.org/api/v1

OpenAPI Definition

The openapi/ directory contains the OpenAPI 3.1 definition for the Magicians VR4Deaf Platform API.

Authentication

Services use short-lived X-Service-Token JWTs (service-to-service). Human administrators use OAuth2 implicit flow against https://magicians.vr4deaf.org/api/oauth/dialog.

Long-lived api_key header tokens are also supported for automated integrations.

Development

Prerequisites

• Node.js ≥ 20.19.0 or ≥ 22.12.0

Install

npm install

Preview docs locally

npm start

Opens a live-reloading Redoc preview at http://localhost:8080.

Validate the spec

npm test

Runs redocly lint against all API definitions.