# speechmatics/speechmatics-academy architecture

> Architecture diagram of the GitHub repository speechmatics/speechmatics-academy, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/speechmatics/speechmatics-academy
- Repository: https://github.com/speechmatics/speechmatics-academy

## Overview

Speechmatics Academy is a copy-ready collection of speech SDK examples, integrations, and use cases—not one deployed application. The principal user journey is choosing an example, supplying credentials and audio, then exploring a speech or voice capability and its result. The graph highlights documented fundamentals and major use-case branches, plus the Voice API Explorer and the internal flows visible in sampled code. Many example implementations were not sampled, so those branches are linked only where the README documents them; unsampled integration details are not inferred.

Main entry points: [`basics`](https://github.com/speechmatics/speechmatics-academy/tree/main/basics) (Fundamentals), [`use-cases/10-wall-of-voices/public/main.js`](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/main.js) (Wall application), [`use-cases/06-medical-assistant/backend/main.py`](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/backend/main.py) (Medical assistant backend), [`basics/11-voice-api-explorer/python/main.py`](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/python/main.py) (Python demo entry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_fundamentals["SDK Fundamentals"]
  node_basics_catalog["Fundamentals"]
  node_batch_realtime["Batch and realtime"]
  node_audio_intelligence["Audio intelligence<br/>[main.py]"]
  node_translation["Translation<br/>[main.py]"]
  node_tts["Text to speech<br/>[main.py]"]
  node_turn_detection["Turn detection<br/>[main.py]"]
  node_voice_features["Voice features<br/>[main.py]"]
  node_agent_stt["Agent STT<br/>[main.py]"]
end

subgraph group_explorer["Voice API Explorer"]
  node_explorer_js_entry["JS demo entry<br/>[main.js]"]
  node_explorer_js_demos["JS API demos<br/>[demos.js]"]
  node_explorer_js_core["JS session core<br/>[core.js]"]
  node_explorer_py_entry["Python demo entry<br/>[main.py]"]
  node_explorer_py_demos["Python API demos<br/>[demos.py]"]
  node_explorer_py_core["Python session core<br/>[core.py]"]
end

subgraph group_integrations["Framework Integrations"]
  node_frameworks["Integration examples"]
end

subgraph group_medical["Medical Workflows"]
  node_medical_frontend["Medical assistant UI<br/>[app.js]"]
  node_medical_backend["Medical assistant backend<br/>[main.py]"]
  node_medical_transcription["Live transcription<br/>[transcription.py]"]
  node_medical_extraction["Clinical extraction<br/>[extraction.py]"]
end

subgraph group_showcases["Use Case Showcases"]
  node_calendar_agent["Calendar receptionist<br/>[main.py]"]
  node_calendar_tools["Calendar tools<br/>[calendar_tools.py]"]
  node_wall_main["Wall application<br/>[main.js]"]
  node_wall_audio["Microphone capture<br/>[audio.js]"]
  node_wall_socket["Melia socket<br/>[melia-socket.js]"]
  node_wall_languages["Language labels<br/>[languages.js]"]
  node_wall_palette["Speaker palette<br/>[palette.js]"]
  node_wall_transcript["Transcript wall<br/>[wall.js]"]
  node_wall_ribbon["Stats ribbon<br/>[ribbon.js]"]
end

node_developer(("Example user"))
node_speechmatics{{"Speechmatics APIs"}}
node_google_calendar{{"Google Calendar"}}

node_developer -->|"chooses example"| node_basics_catalog
node_developer -->|"chooses integration"| node_frameworks
node_basics_catalog -->|"demonstrates modes"| node_batch_realtime
node_basics_catalog -->|"demonstrates insights"| node_audio_intelligence
node_basics_catalog -->|"demonstrates translation"| node_translation
node_basics_catalog -->|"demonstrates synthesis"| node_tts
node_basics_catalog -->|"demonstrates turns"| node_turn_detection
node_basics_catalog -->|"demonstrates speakers"| node_voice_features
node_basics_catalog -->|"demonstrates agent STT"| node_agent_stt
node_explorer_js_entry -->|"dispatches demos"| node_explorer_js_demos
node_explorer_js_demos -->|"runs sessions"| node_explorer_js_core
node_explorer_py_entry -->|"dispatches demos"| node_explorer_py_demos
node_explorer_py_entry -->|"uses audio utilities"| node_explorer_py_core
node_calendar_agent -->|"uses tools"| node_calendar_tools
node_calendar_tools -->|"queries and books"| node_google_calendar
node_medical_frontend -.->|"uses backend"| node_medical_backend
node_medical_backend -->|"starts transcription"| node_medical_transcription
node_medical_backend -->|"requests extraction"| node_medical_extraction
node_wall_main -->|"captures microphone"| node_wall_audio
node_wall_main -->|"streams audio"| node_wall_socket
node_wall_main -->|"labels languages"| node_wall_languages
node_wall_main -->|"updates colors"| node_wall_palette
node_wall_main -->|"renders transcript"| node_wall_transcript
node_wall_main -->|"updates stats"| node_wall_ribbon
node_wall_socket -.->|"streams for transcription"| node_speechmatics

click node_basics_catalog "https://github.com/speechmatics/speechmatics-academy/tree/main/basics"
click node_batch_realtime "https://github.com/speechmatics/speechmatics-academy/tree/main/basics/02-batch-vs-realtime/python"
click node_audio_intelligence "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/04-audio-intelligence/python/main.py"
click node_translation "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/05-multilingual-translation/python/main.py"
click node_tts "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/06-text-to-speech/python/main.py"
click node_turn_detection "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/07-turn-detection/python/main.py"
click node_voice_features "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/09-voice-agent-speaker-id/python/main.py"
click node_agent_stt "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/13-agent-stt/python/main.py"
click node_explorer_js_entry "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/javascript/main.js"
click node_explorer_js_demos "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/javascript/demos.js"
click node_explorer_js_core "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/javascript/core.js"
click node_explorer_py_entry "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/python/main.py"
click node_explorer_py_demos "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/python/demos.py"
click node_explorer_py_core "https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/python/core.py"
click node_frameworks "https://github.com/speechmatics/speechmatics-academy/tree/main/integrations"
click node_calendar_agent "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/04-voice-agent-calendar/python/main.py"
click node_calendar_tools "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/04-voice-agent-calendar/python/calendar_tools.py"
click node_medical_frontend "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/frontend/js/app.js"
click node_medical_backend "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/backend/main.py"
click node_medical_transcription "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/backend/services/transcription.py"
click node_medical_extraction "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/backend/services/extraction.py"
click node_wall_main "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/main.js"
click node_wall_audio "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/audio.js"
click node_wall_socket "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/melia-socket.js"
click node_wall_languages "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/languages.js"
click node_wall_palette "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/palette.js"
click node_wall_transcript "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/wall.js"
click node_wall_ribbon "https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/ribbon.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_basics_catalog,node_batch_realtime,node_audio_intelligence,node_translation,node_tts,node_turn_detection,node_voice_features,node_agent_stt,node_developer toneBlue
class node_explorer_js_entry,node_explorer_js_demos,node_explorer_js_core,node_explorer_py_entry,node_explorer_py_demos,node_explorer_py_core toneAmber
class node_frameworks,node_speechmatics toneMint
class node_medical_frontend,node_medical_backend,node_medical_transcription,node_medical_extraction toneRose
class node_calendar_agent,node_calendar_tools,node_wall_main,node_wall_audio,node_wall_socket,node_wall_languages,node_wall_palette,node_wall_transcript,node_wall_ribbon,node_google_calendar toneIndigo
```

## Components

### SDK Fundamentals

- [Fundamentals](https://github.com/speechmatics/speechmatics-academy/tree/main/basics): `basics`
- [Batch and realtime](https://github.com/speechmatics/speechmatics-academy/tree/main/basics/02-batch-vs-realtime/python): `basics/02-batch-vs-realtime/python`
- [Audio intelligence](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/04-audio-intelligence/python/main.py): `basics/04-audio-intelligence/python/main.py`
- [Translation](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/05-multilingual-translation/python/main.py): `basics/05-multilingual-translation/python/main.py`
- [Text to speech](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/06-text-to-speech/python/main.py): `basics/06-text-to-speech/python/main.py`
- [Turn detection](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/07-turn-detection/python/main.py): `basics/07-turn-detection/python/main.py`
- [Voice features](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/09-voice-agent-speaker-id/python/main.py): `basics/09-voice-agent-speaker-id/python/main.py`
- [Agent STT](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/13-agent-stt/python/main.py): `basics/13-agent-stt/python/main.py`

### Voice API Explorer

- [JS demo entry](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/javascript/main.js): `basics/11-voice-api-explorer/javascript/main.js`
- [JS API demos](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/javascript/demos.js): `basics/11-voice-api-explorer/javascript/demos.js`
- [JS session core](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/javascript/core.js): `basics/11-voice-api-explorer/javascript/core.js`
- [Python demo entry](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/python/main.py): `basics/11-voice-api-explorer/python/main.py`
- [Python API demos](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/python/demos.py): `basics/11-voice-api-explorer/python/demos.py`
- [Python session core](https://github.com/speechmatics/speechmatics-academy/blob/main/basics/11-voice-api-explorer/python/core.py): `basics/11-voice-api-explorer/python/core.py`

### Framework Integrations

- [Integration examples](https://github.com/speechmatics/speechmatics-academy/tree/main/integrations): `integrations`

### Medical Workflows

- [Medical assistant UI](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/frontend/js/app.js): `use-cases/06-medical-assistant/frontend/js/app.js`
- [Medical assistant backend](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/backend/main.py): `use-cases/06-medical-assistant/backend/main.py`
- [Live transcription](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/backend/services/transcription.py): `use-cases/06-medical-assistant/backend/services/transcription.py`
- [Clinical extraction](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/06-medical-assistant/backend/services/extraction.py): `use-cases/06-medical-assistant/backend/services/extraction.py`

### Use Case Showcases

- [Calendar receptionist](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/04-voice-agent-calendar/python/main.py): `use-cases/04-voice-agent-calendar/python/main.py`
- [Calendar tools](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/04-voice-agent-calendar/python/calendar_tools.py): `use-cases/04-voice-agent-calendar/python/calendar_tools.py`
- [Wall application](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/main.js): `use-cases/10-wall-of-voices/public/main.js`
- [Microphone capture](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/audio.js): `use-cases/10-wall-of-voices/public/audio.js`
- [Melia socket](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/melia-socket.js): `use-cases/10-wall-of-voices/public/melia-socket.js`
- [Language labels](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/languages.js): `use-cases/10-wall-of-voices/public/languages.js`
- [Speaker palette](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/palette.js): `use-cases/10-wall-of-voices/public/palette.js`
- [Transcript wall](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/wall.js): `use-cases/10-wall-of-voices/public/wall.js`
- [Stats ribbon](https://github.com/speechmatics/speechmatics-academy/blob/main/use-cases/10-wall-of-voices/public/ribbon.js): `use-cases/10-wall-of-voices/public/ribbon.js`

### Other components

- **Example user**
- **Speechmatics APIs**
- **Google Calendar**

## Connections

- Example user → Fundamentals: chooses example (evidence: `README.md`)
- Example user → Integration examples: chooses integration (evidence: `README.md`)
- Fundamentals → Batch and realtime: demonstrates modes (evidence: `README.md`)
- Fundamentals → Audio intelligence: demonstrates insights (evidence: `README.md`)
- Fundamentals → Translation: demonstrates translation (evidence: `README.md`)
- Fundamentals → Text to speech: demonstrates synthesis (evidence: `README.md`)
- Fundamentals → Turn detection: demonstrates turns (evidence: `README.md`)
- Fundamentals → Voice features: demonstrates speakers (evidence: `README.md`)
- Fundamentals → Agent STT: demonstrates agent STT (evidence: `README.md`)
- JS demo entry → JS API demos: dispatches demos (evidence: `basics/11-voice-api-explorer/javascript/main.js`)
- JS API demos → JS session core: runs sessions (evidence: `basics/11-voice-api-explorer/javascript/demos.js`)
- Python demo entry → Python API demos: dispatches demos (evidence: `basics/11-voice-api-explorer/python/main.py`)
- Python demo entry → Python session core: uses audio utilities (evidence: `basics/11-voice-api-explorer/python/main.py`)
- Calendar receptionist → Calendar tools: uses tools (evidence: `use-cases/04-voice-agent-calendar/python/main.py`)
- Calendar tools → Google Calendar: queries and books (evidence: `use-cases/04-voice-agent-calendar/python/calendar_tools.py`)
- Medical assistant UI → Medical assistant backend: uses backend
- Medical assistant backend → Live transcription: starts transcription (evidence: `use-cases/06-medical-assistant/backend/main.py`)
- Medical assistant backend → Clinical extraction: requests extraction (evidence: `use-cases/06-medical-assistant/backend/main.py`)
- Wall application → Microphone capture: captures microphone (evidence: `use-cases/10-wall-of-voices/public/main.js`)
- Wall application → Melia socket: streams audio (evidence: `use-cases/10-wall-of-voices/public/main.js`)
- Wall application → Language labels: labels languages (evidence: `use-cases/10-wall-of-voices/public/main.js`)
- Wall application → Speaker palette: updates colors (evidence: `use-cases/10-wall-of-voices/public/main.js`)
- Wall application → Transcript wall: renders transcript (evidence: `use-cases/10-wall-of-voices/public/main.js`)
- Wall application → Stats ribbon: updates stats (evidence: `use-cases/10-wall-of-voices/public/main.js`)
- Melia socket → Speechmatics APIs: streams for transcription
