Speakr is a personal, self-hosted web application designed for transcribing audio recordings
Python
Update docs and version to 0.8.0 for connector architecture and API release
Murtaza Nasir7f9562b7d8a4
diff --git a/README.md b/README.mdindex 347d20fd..fbc0c2fa 100644--- a/README.md+++ b/README.md@@ -9,7 +9,7 @@<a href="https://www.gnu.org/licenses/agpl-3.0"><img alt="AGPL v3" src="https://img.shields.io/badge/License-AGPL_v3-blue.svg"></a><a href="https://github.com/murtaza-nasir/speakr/actions/workflows/docker-publish.yml"><img alt="Docker Build" src="https://github.com/murtaza-nasir/speakr/actions/workflows/docker-publish.yml/badge.svg"></a><a href="https://hub.docker.com/r/learnedmachine/speakr"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/learnedmachine/speakr"></a>- <a href="https://github.com/murtaza-nasir/speakr/releases/latest"><img alt="Latest Version" src="https://img.shields.io/badge/version-0.7.2-brightgreen.svg"></a>+ <a href="https://github.com/murtaza-nasir/speakr/releases/latest"><img alt="Latest Version" src="https://img.shields.io/badge/version-0.8.0-brightgreen.svg"></a></p><p align="center">@@ -36,6 +36,7 @@ Speakr transforms your audio recordings into organized, searchable, and intellig- **Smart Recording & Upload** - Record directly in browser or upload existing audio files- **AI Transcription** - High-accuracy transcription with speaker identification- **Voice Profiles** - AI-powered speaker recognition with voice embeddings (requires WhisperX ASR service)+- **REST API v1** - Complete API with Swagger UI for automation tools (n8n, Zapier, Make) and dashboard widgets- **Single Sign-On** - Authenticate with any OIDC provider (Keycloak, Azure AD, Google, Auth0, Pocket ID)- **Audio-Transcript Sync** - Click transcript to jump to audio, auto-highlight current text, follow mode for hands-free playback- **Interactive Chat** - Ask questions about your recordings and get AI-powered answers@@ -148,7 +149,20 @@ Complete documentation is available at **[murtaza-nasir.github.io/speakr](https:- [Troubleshooting](https://murtaza-nasir.github.io/speakr/troubleshooting) - Common issues and solutions- [FAQ](https://murtaza-nasir.github.io/speakr/faq) - Frequently asked questions-## Latest Release (v0.7.2)+## Latest Release (v0.8.0)++**Connector Architecture & REST API**++- **Connector-Based Transcription** - New modular architecture for transcription providers with auto-detection+- **Simplified Configuration** - Fewer environment variables needed; auto-detects connector from settings+- **OpenAI Diarization Support** - Use `gpt-4o-transcribe-diarize` for speaker identification without self-hosting+- **REST API v1** - Full-featured API for automation tools (n8n, Zapier, Make) and dashboard widgets+- **Interactive API Docs** - Swagger UI at `/api/v1/docs` with try-it-out functionality+- **Batch Operations** - Update, delete, or transcribe multiple recordings via API++> **Migration Note:** Existing configurations are fully backwards compatible. See the [Migration Guide](https://murtaza-nasir.github.io/speakr/admin-guide/migration-guide) for recommended updates.++### Previous Release (v0.7.2)**Token Budgets, Performance & UX**@@ -235,9 +249,10 @@ Complete documentation is available at **[murtaza-nasir.github.io/speakr](https:- ✅ Multi-user job queue with fair scheduling (v0.6.0)- ✅ SSO integration with OIDC providers (v0.7.0)- ✅ Token usage tracking and per-user budgets (v0.7.2)+- ✅ Connector-based transcription architecture with auto-detection (v0.8.0)+- ✅ Comprehensive REST API with Swagger UI documentation (v0.8.0)### Near-term-- Bulk operations for recordings (mass delete, export, tagging)- Quick language switching for transcription- Automated workflow triggersdiff --git a/docs/assets/images/screenshots/api-swagger-ui.png b/docs/assets/images/screenshots/api-swagger-ui.pngnew file mode 100644index 00000000..d4a76331Binary files /dev/null and b/docs/assets/images/screenshots/api-swagger-ui.png differdiff --git a/docs/index.md b/docs/index.mdindex e48399c9..d999279c 100644--- a/docs/index.md+++ b/docs/index.md@@ -6,16 +6,17 @@ Speakr is a powerful self-hosted transcription platform that helps you capture,<img src="assets/images/screenshots/Main view.png" alt="Main Interface" style="border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.1);"></div>-!!! info "Latest Release: v0.7.1 - Stability & Audio Improvements"- **Bug Fixes & Improvements**+!!! info "Latest Release: v0.8.0 - Connector Architecture & REST API"+ **Modular Transcription & Full API Access**- - **PostgreSQL Support** - Added `psycopg2-binary` driver for PostgreSQL database option (#159)- - **Audio Download Button** - Explicit download button next to audio player, works on mobile (#155)- - **Job Queue Race Condition Fix** - Fixed issue where multiple workers could claim the same job, causing "FFmpeg not found" errors (#150)- - **Audio Conversion Pipeline Refactor** - Improved format detection using ffprobe, better codec support (#158)- - **Codec Compatibility Check** - Unsupported audio codecs are now automatically converted before transcription+ - **Connector-Based Transcription** - New modular architecture with auto-detection for transcription providers+ - **Simplified Configuration** - Fewer env vars needed; just set `ASR_BASE_URL` or `TRANSCRIPTION_MODEL`+ - **OpenAI Diarization** - Use `gpt-4o-transcribe-diarize` for speaker identification without self-hosting+ - **REST API v1** - Complete API for automation tools (n8n, Zapier, Make) and dashboard widgets+ - **Interactive Swagger UI** - Browse and test all endpoints at `/api/v1/docs`+ - **Batch Operations** - Update, delete, or transcribe multiple recordings via API- *Thanks to [sakowicz](https://github.com/sakowicz) for PR #159, [JadedBlueEyes](https://github.com/JadedBlueEyes) for PR #158, and [Daabramov](https://github.com/Daabramov) for debugging #150*+ **Migration:** Existing configs are backwards compatible. See the [Migration Guide](admin-guide/migration-guide.md) for recommended updates and the [API Reference](user-guide/api-reference.md) for API documentation.## Quick Navigation@@ -122,11 +123,12 @@ Speakr is a powerful self-hosted transcription platform that helps you capture,</div><div class="feature-card">- <h4>🔑 API Access</h4>+ <h4>🔑 REST API</h4><ul>+ <li><a href="user-guide/api-reference">Full REST API v1</a></li><li><a href="user-guide/api-tokens">Personal access tokens</a></li>- <li>Automation tool integration</li>- <li>Secure token management</li>+ <li>Interactive <a href="user-guide/api-reference#openapi-specification">Swagger UI docs</a></li>+ <li>n8n, Zapier, Make integration</li></ul></div></div>diff --git a/docs/user-guide/api-reference.md b/docs/user-guide/api-reference.mdindex 642ceb91..6510233d 100644--- a/docs/user-guide/api-reference.md+++ b/docs/user-guide/api-reference.md@@ -41,6 +41,11 @@ All endpoints require authentication. See [API Tokens](api-tokens.md) for detail| `GET /api/v1/docs` | Interactive Swagger UI || `GET /api/v1/openapi.json` | OpenAPI 3.0 specification |+<div style="max-width: 90%; margin: 1.5em auto;">+ <img src="../../assets/images/screenshots/api-swagger-ui.png" alt="Swagger UI Documentation" style="border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.1);">+ <p style="text-align: center; margin-top: 0.5rem; font-style: italic; color: #666;">Interactive API documentation with Swagger UI at /api/v1/docs</p>+</div>+---## Statsdiff --git a/mkdocs.yml b/mkdocs.ymlindex 5f70a1c9..00763d93 100644--- a/mkdocs.yml+++ b/mkdocs.yml@@ -176,6 +176,7 @@ nav:- System Settings: admin-guide/system-settings.md- Default Prompts: admin-guide/prompts.md- Vector Store: admin-guide/vector-store.md+ - Migration Guide: admin-guide/migration-guide.md- Troubleshooting: troubleshooting.md- FAQ: faq.md\ No newline at end of file