Stabil

Windows ist ein stabiles Desktop-Release. Die Windows-API ist für lokale Tools und Automatisierung verfügbar.

HTTP API

Steuere Transkription, Diktat, Recorder, Verlauf und Wörterbuch über eine lokale HTTP-Schnittstelle.

Nur lokal: Der Server bindet ausschließlich an localhost beziehungsweise 127.0.0.1. Er ist standardmäßig deaktiviert und verwendet Port 8978.

Server aktivieren

Öffne Einstellungen > Erweitert > API Server.
Aktiviere den API-Server und behalte Port 8978 oder trage einen freien lokalen Port ein.
Prüfe den Status in PowerShell:

curl.exe http://localhost:8978/v1/status

API-Server-Einstellungen im Bereich Erweitert

Discovery und Token

Beim Start schreibt der Server zwei Discovery-Dateien nach %LOCALAPPDATA%\TypeWhisper-UserData: api-discovery.json mit Version, Port und Token sowie die ältere Datei api-port.

{
  "version": 1,
  "port": 8978,
  "token": "..."
}

Token-Authentifizierung ist optional. Wenn „API-Token erforderlich“ aktiv ist, bleibt nur /v1/status öffentlich. Sende den Token bei allen anderen Anfragen als Bearer-Token oder im Header X-TypeWhisper-API-Token.

$discovery = Get-Content "$env:LOCALAPPDATA\TypeWhisper-UserData\api-discovery.json" | ConvertFrom-Json

curl.exe -H "Authorization: Bearer $($discovery.token)" "http://localhost:$($discovery.port)/v1/models"

Audio transkribieren

Sende eine Datei als multipart/form-data. language und language_hint schließen sich gegenseitig aus; language_hint darf mehrfach und in Prioritätsreihenfolge vorkommen.

curl.exe -X POST http://localhost:8978/v1/transcribe `
  -F "file=@recording.wav" `
  -F "language_hint=de" `
  -F "language_hint=en" `
  -F "response_format=verbose_json"

Weitere Felder: task (transcribe oder translate), target_language, prompt, engine und model. Mit await_download=1 wartet die Anfrage bei unterstützten lokalen Engines auf Download oder Wiederherstellung des Modells.

Für bereits lokale Dateien akzeptiert /v1/transcribe/local-file einen Windows-Pfad als JSON. Dadurch muss eine große Datei nicht nochmals durch den API-Prozess hochgeladen werden.

Stabile Endpunkte

Methode	Route	Zweck
GET	/v1/status	Server-, Engine- und Modellstatus
GET	/v1/models	Verfügbare lokale und Cloud-Modelle
POST	/v1/transcribe	Multipart- oder Raw-Audio transkribieren
POST	/v1/transcribe/local-file	Lokalen Windows-Dateipfad transkribieren
GET	/v1/history	Verlauf durchsuchen und seitenweise lesen
DELETE	/v1/history	Verlaufseintrag anhand seiner ID löschen
POST	/v1/dictation/start	Diktataufnahme starten
POST	/v1/dictation/stop	Diktataufnahme beenden
GET	/v1/dictation/status	Aktuellen Diktatstatus lesen
GET	/v1/dictation/transcription	Diktatergebnis über die Session-ID abrufen
POST	/v1/recorder/start	Recorder-Sitzung starten
POST	/v1/recorder/stop	Recorder-Sitzung stoppen
GET	/v1/recorder/status	Recorder-Status lesen
GET	/v1/recorder/session	Recorder-Sitzung über ihre ID lesen
GET	/v1/dictionary/terms	Aktivierte Wörterbuchbegriffe lesen
PUT	/v1/dictionary/terms	Begriffe ergänzen oder ersetzen
DELETE	/v1/dictionary/terms	Einen Begriff löschen
GET	/v1/dictionary/corrections	Aktivierte Korrekturen lesen
PUT	/v1/dictionary/corrections	Eine Korrektur anlegen oder aktualisieren
DELETE	/v1/dictionary/corrections	Eine Korrektur löschen

Workflow-Kompatibilitätsrouten

/v1/rules und /v1/profiles sowie ihre PUT-Routen /toggle bleiben für bestehende Integrationen erhalten. Beide liefern die heutige Workflow-Konfiguration; für neue Oberflächen und Dokumentation heißt das Konzept Workflows.