Assistiv Platform Docsdocs

API Surface Summary

High-level map of backend and Aurora route domains, with recommendations for next-stage API documentation.

This page summarizes the currently observed API surface from route registration in source code.

assistiv-backend Route Domains

DomainPrefixExample capabilities
Auth/authlogin, logout, session validation, SAML/OAuth flows
Users/userprofile, course progress, upcoming activities
Courses/coursecourse/unit/subunit create/update/reorder
Content/contentdocument/resource/video operations
Quiz/quizattempt lifecycle and quiz data
Assignments/assignmentassignment creation/submission/grading
Groups/groupuser groups and group-course management
Admin/admintenant admin operations, roles, invite links
Progress/progressstudent/classroom analytics and grading views
Study/studyflashcards, study questions, tutor sessions
Spaces/spaces via root routeruser study spaces, uploads, shared sessions
Logging/logfrontend and Aurora error logs
System/systemsystem users, token limits, enterprise setup

Aurora Route Domains

All routes are under /aurora/v1.

Path familyFocus
/insightinsight-style AI outputs
/queryquery and response workflows
/coursecourse-aware AI endpoints
/quizquiz-related AI generation/support
/studystudy material AI workflows
/spacesspace-specific AI interactions
/sourcessource retrieval/research workflows
/documentdocument operations, including summarization

OpenAPI Status

No OpenAPI or Swagger spec files were detected in the scanned repositories during this pass.

Recommended Next Step for API Docs

  1. Export or hand-author OpenAPI specs for assistiv-backend and aurora.
  2. Add specs to this docs repository (for example openapi/backend.yaml, openapi/aurora.yaml).
  3. Configure docs.json api.openapi.
  4. Add endpoint pages that use openapi frontmatter so Jamdesk auto-generates request and response schema docs.