Skip to main content

OpenAI-compatible ASR server with pluggable local backends.

Project description

Open ASR Server

CI PyPI

OpenAI-compatible ASR server with pluggable local transcription backends.

Install

Base install includes the API server and shared models/formatters:

uv tool install "open-asr-server"

Add backend extras as needed:

uv tool install "open-asr-server[parakeet]"         # MLX Parakeet (Apple Silicon)
uv tool install "open-asr-server[whisper]"          # MLX Whisper
uv tool install "open-asr-server[lightning-whisper]" # MLX Lightning Whisper
uv tool install "open-asr-server[kyutai-mlx]"        # Kyutai STT (MLX)
uv tool install "open-asr-server[faster-whisper]"    # CPU (CTranslate2)
uv tool install "open-asr-server[whisper-cpp]"       # CPU (whisper.cpp)

Notes:

  • MLX Whisper/Lightning/Parakeet extras are currently pinned to Python 3.11.
  • Kyutai MLX is currently pinned to Python 3.12.

MLX troubleshooting

If MLX extras fail on newer Python versions, use Python 3.11 for Parakeet/Whisper/Lightning:

uv run --python 3.11 --extra whisper -- open-asr-server serve --host 127.0.0.1 --port 8000

For Kyutai MLX, use Python 3.12:

uv run --python 3.12 --extra kyutai-mlx -- open-asr-server serve --host 127.0.0.1 --port 8000

Run

Install at least one backend extra before running (the default model uses Parakeet MLX):

uv tool install "open-asr-server[parakeet]"

Then start the server:

uv tool run open-asr-server serve --host 127.0.0.1 --port 8000

Environment variables:

  • OPEN_ASR_SERVER_DEFAULT_MODEL: default model ID for requests
  • OPEN_ASR_DEFAULT_BACKEND: preferred backend when model patterns overlap
  • OPEN_ASR_SERVER_PRELOAD: comma-separated models to preload at startup
  • OPEN_ASR_SERVER_API_KEY: optional shared secret for requests
  • OPEN_ASR_SERVER_ALLOWED_MODELS: comma-separated allowed model IDs or patterns
  • OPEN_ASR_SERVER_MAX_UPLOAD_BYTES: max upload size in bytes (default: 26214400)
  • OPEN_ASR_SERVER_RATE_LIMIT_PER_MINUTE: optional per-client request limit (off by default)
  • OPEN_ASR_SERVER_TRANSCRIBE_TIMEOUT_SECONDS: optional transcription timeout (off by default)
  • OPEN_ASR_SERVER_TRANSCRIBE_WORKERS: optional thread pool size for transcriptions
  • OPEN_ASR_SERVER_MODEL_DIR: override the Hugging Face cache location for this server
  • OPEN_ASR_SERVER_HF_TOKEN: optional Hugging Face token for gated/private models

Models default to the Hugging Face cache unless a local path is provided. Use OPEN_ASR_SERVER_MODEL_DIR if you want a dedicated cache without changing your global HF environment. Use OPEN_ASR_SERVER_HF_TOKEN to authenticate downloads without setting global HF environment variables.

Use OPEN_ASR_SERVER_TRANSCRIBE_TIMEOUT_SECONDS to bound long transcriptions. If you set OPEN_ASR_SERVER_TRANSCRIBE_WORKERS, transcriptions run in a background thread pool instead of the event loop.

Sample audio

Two short clips are included in samples/ for quick smoke tests:

  • samples/jfk_0_5.flac
  • samples/jfk_5_10.flac

They are derived from tests/jfk.flac in the OpenAI Whisper repo (MIT); the original JFK speech is public domain.

uv run --extra parakeet scripts/smoke_parakeet.py samples/jfk_0_5.flac
uv run --python 3.11 --extra whisper scripts/smoke_whisper.py samples/jfk_0_5.flac
uv run --python 3.11 --extra lightning-whisper scripts/smoke_lightning.py samples/jfk_0_5.flac
uv run --extra whisper-cpp scripts/smoke_whisper_cpp.py samples/jfk_0_5.flac
uv run --python 3.12 --extra kyutai-mlx scripts/smoke_kyutai_mlx.py samples/jfk_0_5.flac

Backend options

Backends are selected by model ID patterns. Use backend:model when you need an explicit backend.

Metal (Apple Silicon)

  • Parakeet MLX: mlx-community/parakeet-tdt-0.6b-v3 (default) or parakeet-*
  • MLX Whisper: whisper-large-v3-turbo or mlx-community/whisper-large-v3-turbo
  • Lightning Whisper MLX: lightning-whisper-distil-large-v3
  • Kyutai STT MLX: kyutai/stt-*-mlx

CPU

  • Faster-Whisper: openai/whisper-* and distil-whisper/*
  • whisper.cpp: tiny*, base*, small*, medium*, large*

API compatibility

The server implements:

  • POST /v1/audio/transcriptions
  • GET /v1/models
  • GET /v1/models/metadata

Example:

curl -s -X POST "http://127.0.0.1:8000/v1/audio/transcriptions" \
  -F "file=@audio.wav" \
  -F "model=whisper-large-v3-turbo"

Security

This server is designed for trusted networks. If you expose it publicly, enable OPEN_ASR_SERVER_API_KEY and front it with a reverse proxy that provides TLS and rate limiting. OPEN_ASR_SERVER_RATE_LIMIT_PER_MINUTE offers a simple in-process limiter for single-instance use, but it is not a substitute for production-grade rate limiting.

API key headers:

  • Authorization: Bearer <token>
  • X-API-Key: <token>

Use OPEN_ASR_SERVER_ALLOWED_MODELS to limit which model IDs can be loaded and prevent unbounded downloads. Avoid logging request bodies or filenames if those may contain sensitive data, and review reverse-proxy access logs for any retention concerns.

Release

uv version --bump patch
uv run --extra dev pytest
uv build --no-sources
uv publish --index testpypi --token "$UV_PUBLISH_TOKEN"
uv publish --token "$UV_PUBLISH_TOKEN"

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_asr_server-0.1.3.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_asr_server-0.1.3-py3-none-any.whl (29.0 kB view details)

Uploaded Python 3

File details

Details for the file open_asr_server-0.1.3.tar.gz.

File metadata

  • Download URL: open_asr_server-0.1.3.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for open_asr_server-0.1.3.tar.gz
Algorithm Hash digest
SHA256 aa8123fd58dc48e332b7e8915bdcdaec40cce49b33e9fa9bb38873f1e737dba2
MD5 085bbac259842398db879f7f4182b84b
BLAKE2b-256 13a8398bfb3704585ea98cf797944d0ad21bd6f7bde173a7908cbf65462e31d2

See more details on using hashes here.

File details

Details for the file open_asr_server-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: open_asr_server-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 29.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for open_asr_server-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1036434494900d6371ebf99512b16a3debcc0ec977941e4ed87575ad72e893c9
MD5 a6474167992f56aaed750a9e59931854
BLAKE2b-256 d69586d6ca0e5697dc7492c6c75eeb15f9ead56b609754d1dafc95339a4c8cb5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page