Docs / Raw

API Routes Reference

Sourced from docs/api-reference/API_ROUTES.md

Edit on GitHub

API Routes Reference

Generated: 2025-11-27 12:24:10 UTC App: VoiceAssist API Gateway Version: 0.1.0

Summary

  • Total Routes: 98
  • Total Tags/Modules: 9

Tags Overview

TagRoutesDescription
admin21
authentication8
conversations16Chat sessions and branching
health4Service health and readiness checks
integrations10Nextcloud and external services
observability1
untagged22
users11User profile and management
voice5Voice input/output and transcription

Routes by Tag

Admin

MethodPathSummaryAuth
POST/api/admin/cache/clearClear CacheYes
POST/api/admin/cache/invalidateInvalidate Cache PatternYes
GET/api/admin/cache/statsGet Cache StatsYes
GET/api/admin/feature-flagsList Feature FlagsYes
POST/api/admin/feature-flagsCreate Feature FlagYes
DELETE/api/admin/feature-flags/{flag_name}Delete Feature FlagYes
GET/api/admin/feature-flags/{flag_name}Get Feature FlagYes
PATCH/api/admin/feature-flags/{flag_name}Update Feature FlagYes
POST/api/admin/feature-flags/{flag_name}/toggleToggle Feature FlagYes
GET/api/admin/kb/documentsList DocumentsYes
POST/api/admin/kb/documentsUpload DocumentYes
DELETE/api/admin/kb/documents/{document_id}Delete DocumentYes
GET/api/admin/kb/documents/{document_id}Get DocumentYes
GET/api/admin/panel/audit-logsGet Audit LogsYes
GET/api/admin/panel/metricsGet System MetricsYes
GET/api/admin/panel/summaryGet System SummaryYes
GET/api/admin/panel/usersList UsersYes
DELETE/api/admin/panel/users/{user_id}Delete UserYes
GET/api/admin/panel/users/{user_id}Get UserYes
PUT/api/admin/panel/users/{user_id}Update UserYes
GET/api/admin/panel/websocket-statusGet Websocket StatusYes

Authentication

MethodPathSummaryAuth
POST/api/auth/loginLoginNo
POST/api/auth/logoutLogoutYes
GET/api/auth/meGet Current User InfoYes
GET/api/auth/oauth/{provider}/authorizeOauth AuthorizeNo
POST/api/auth/oauth/{provider}/callbackOauth CallbackNo
GET/api/auth/oauth/{provider}/statusOauth Provider StatusNo
POST/api/auth/refreshRefresh TokenNo
POST/api/auth/registerRegisterNo

Conversations

MethodPathSummaryAuth
GET/api/conversationsList ConversationsYes
POST/api/conversationsCreate ConversationYes
DELETE/api/conversations/{conversation_id}Delete ConversationYes
GET/api/conversations/{conversation_id}Get ConversationYes
PATCH/api/conversations/{conversation_id}Update ConversationYes
GET/api/conversations/{conversation_id}/eventsGet Conversation EventsYes
GET/api/conversations/{conversation_id}/messagesGet MessagesYes
POST/api/conversations/{conversation_id}/messagesCreate MessageYes
DELETE/api/conversations/{conversation_id}/messages/{message_id}Delete MessageYes
PATCH/api/conversations/{conversation_id}/messages/{message_id}Edit MessageYes
GET/api/conversations/{conversation_id}/settingsGet Conversation SettingsYes
PATCH/api/conversations/{conversation_id}/settingsPatch Conversation SettingsYes
PUT/api/conversations/{conversation_id}/settingsUpdate Conversation SettingsYes
GET/api/conversations/{session_id}/branchesList BranchesYes
POST/api/conversations/{session_id}/branchesCreate BranchYes
GET/api/conversations/{session_id}/branches/{branch_id}/messagesGet Branch MessagesYes

Health

MethodPathSummaryAuth
GET/healthHealth CheckNo
GET/health/detailedDetailed Health CheckNo
GET/health/openaiOpenai Health CheckNo
GET/readyReadiness CheckNo

Integrations

MethodPathSummaryAuth
GET/api/integrations/calendar/calendarsList CalendarsYes
GET/api/integrations/calendar/eventsList EventsYes
POST/api/integrations/calendar/eventsCreate EventYes
DELETE/api/integrations/calendar/events/{event_uid}Delete EventYes
PUT/api/integrations/calendar/events/{event_uid}Update EventYes
GET/api/integrations/email/foldersList Email FoldersYes
GET/api/integrations/email/messagesList Email MessagesYes
POST/api/integrations/email/sendSend EmailYes
POST/api/integrations/files/indexIndex Specific FileYes
POST/api/integrations/files/scan-and-indexScan And Index FilesYes

Observability

MethodPathSummaryAuth
GET/metricsPrometheus MetricsNo

Untagged

MethodPathSummaryAuth
DELETE/api/attachments/{attachment_id}Delete AttachmentYes
GET/api/attachments/{attachment_id}/downloadDownload AttachmentYes
POST/api/clinical-contextsCreate Clinical ContextYes
GET/api/clinical-contexts/currentGet Current Clinical ContextYes
DELETE/api/clinical-contexts/{context_id}Delete Clinical ContextYes
GET/api/clinical-contexts/{context_id}Get Clinical ContextYes
PUT/api/clinical-contexts/{context_id}Update Clinical ContextYes
GET/api/foldersList FoldersYes
POST/api/foldersCreate FolderYes
GET/api/folders/treeGet Folder TreeYes
DELETE/api/folders/{folder_id}Delete FolderYes
GET/api/folders/{folder_id}Get FolderYes
PUT/api/folders/{folder_id}Update FolderYes
POST/api/folders/{folder_id}/move/{target_folder_id}Move FolderYes
GET/api/messages/{message_id}/attachmentsList AttachmentsYes
POST/api/messages/{message_id}/attachmentsUpload AttachmentYes
GET/api/sessions/{session_id}/export/markdownExport MarkdownYes
GET/api/sessions/{session_id}/export/pdfExport PdfYes
POST/api/sessions/{session_id}/shareCreate Share LinkYes
DELETE/api/sessions/{session_id}/share/{share_token}Revoke Share LinkYes
GET/api/sessions/{session_id}/sharesList Share LinksYes
GET/api/shared/{share_token}Get Shared ConversationNo

Users

MethodPathSummaryAuth
GET/api/users/List UsersYes
DELETE/api/users/meDelete Current User AccountYes
GET/api/users/meGet Current User ProfileYes
PUT/api/users/meUpdate Current User ProfileYes
POST/api/users/me/change-passwordChange PasswordYes
GET/api/users/{user_id}Get User By IdYes
PATCH/api/users/{user_id}Update UserYes
PUT/api/users/{user_id}/activateActivate UserYes
PUT/api/users/{user_id}/deactivateDeactivate UserYes
PUT/api/users/{user_id}/promote-adminPromote To AdminYes
PUT/api/users/{user_id}/revoke-adminRevoke Admin PrivilegesYes

Voice

MethodPathSummaryAuth
POST/api/voice/metricsSubmit voice session metricsYes
POST/api/voice/realtime-sessionCreate Realtime API sessionYes
POST/api/voice/relayRelay final voice transcript to RAGYes
POST/api/voice/synthesizeSynthesize speech from textYes
POST/api/voice/transcribeTranscribe audio to textYes

Authentication

Most endpoints require authentication via Bearer token:

Authorization: Bearer <access_token>

Obtain tokens via /api/auth/login or /api/auth/register.

OpenAPI Specification

The complete OpenAPI 3.0 specification is available at:

  • Swagger UI: /docs
  • ReDoc: /redoc
  • OpenAPI JSON: /openapi.json

This document is auto-generated from the OpenAPI specification. Do not edit manually - regenerate using tools/generate_api_docs.py.

← All documentationHome
Beginning of guide
End of guide