API-Übersicht & Authentifizierung

OneASR bietet eine standardisierte, hochperformante REST- und WebSocket-API-Suite für Spracherkennung, Medienanalyse und Dateiverwaltung.

---

Basis-URLs

• Lokale Bereitstellung: http://localhost:8000
• OpenAI-kompatibler Endpunkt: http://localhost:8000/v1
• Echtzeit-WebSocket-Endpunkt: ws://localhost:8000/v1/realtime (oder /v1/realtimeext)

---

Authentifizierung

Alle Anfragen an OneASR-Endpunkte erfordern einen gültigen API-Schlüssel, der in config.yaml konfiguriert ist (api_key: sk-oneasr-...).

Sie können den API-Schlüssel über eine der folgenden drei Methoden übergeben:

1. HTTP Bearer Token (Standard-OpenAI-Format)

Authorization: Bearer sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u

2. Benutzerdefinierter Header (X-API-Key)

X-API-Key: sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u

3. URL-Abfrageparameter (Empfohlen für WebSockets)

ws://localhost:8000/v1/realtime?api_key=sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u

---

Funktionale API-Gruppen

Gruppe	Endpunkte	Protokoll	Beschreibung
OpenAI Audio	/v1/audio/transcriptions, /v1/models	HTTP REST	Direkter OpenAI-Ersatz für Spracherkennung und Modellerkennung
Echtzeit-Stream	/v1/realtime, /v1/realtimeext	WebSocket	Live-Audio-Streaming mit geringer Latenz und VAD im Vollduplexbetrieb
Dateitranskription	/v1/file-transcription/transcriptions	HTTP & SSE	Asynchrone Hintergrundverarbeitung für große Mediendateien (bis zu 2 GB)
Dateispeicher	/v1/files/*, /v1/files/fetch-url	HTTP REST	Dateiuploads, Speicherverwaltung und Remote-URL-Downloads
Medien & Engine	/v1/media/parse, /v1/providers	HTTP REST	Audiotrack-Extraktion und Status der Engine-Provider