Zum Hauptinhalt springen

HTTP-API

FreezeText bietet eine lokale HTTP-API für Automatisierung und Integration mit anderen Anwendungen. Die API muss in den Einstellungen unter API aktiviert werden.

Einrichtung

  1. Öffnen Sie die Einstellungen → API
  2. Aktivieren Sie API-Server aktivieren
  3. Optional: Generieren Sie ein API-Token für die Authentifizierung
  4. Der Server ist unter http://localhost:9876 erreichbar

Authentifizierung

Wenn ein API-Token konfiguriert ist, muss jede Anfrage den Token als Bearer-Token im Authorization-Header senden:

Authorization: Bearer <Ihr-Token>

Endpunkte

Erfassung & OCR

EndpunktMethodeBeschreibung
/statusGETServerstatus, Version, Verlaufsanzahl
/captureGET/POSTTexterfassung starten
/capture/cancelPOSTLaufende Erfassung abbrechen
/capture/regionPOSTBestimmten Bildschirmbereich erfassen und OCR durchführen
/ocrPOSTOCR auf übergebenem Bild ausführen
/ocr/languagesGET/PUTOCR-Sprachen abrufen/ändern

Verlauf

EndpunktMethodeBeschreibung
/historyGETAlle Einträge abrufen (Filter nach Farbe, Sortierung)
/history/search?q=GETVolltextsuche im Verlauf
/historyPOSTNeuen Eintrag hinzufügen
/history/:idGETEinzelnen Eintrag abrufen
/history/:idPUTEintragstext ändern
/history/:idDELETEEintrag löschen
/historyDELETEAlle Einträge löschen
/history/:id/screenshotGETScreenshot eines Eintrags abrufen
/history/export/jsonGETVerlauf als JSON exportieren
/history/export/csvGETVerlauf als CSV exportieren

Einstellungen & UI

EndpunktMethodeBeschreibung
/settingsGET/PUTEinstellungen abrufen/ändern
/hotkeyGET/PUTHotkey abrufen/ändern
/hotkey/resetPOSTHotkey auf Standard zurücksetzen
/preferencesGET/POSTEinstellungsfenster öffnen (optional Tab-Parameter)
/sidebarGETSeitenleisten-Status
/sidebar/showPOSTSeitenleiste anzeigen
/sidebar/hidePOSTSeitenleiste ausblenden
/sidebar/togglePOSTSeitenleiste ein-/ausblenden
/aboutGET/POSTInfo-Fenster anzeigen
/onboardingGET/POSTOnboarding-Assistent anzeigen

Screenshots & Fenster

EndpunktMethodeBeschreibung
/windowsGETAlle sichtbaren FreezeText-Fenster auflisten
/screenshotGETFreezeText-Fenster als PNG erfassen
/screenGETVollbildschirm als PNG erfassen
/sidebar/screenshotGETSeitenleiste als PNG erfassen
/displaysGETAlle angeschlossenen Bildschirme auflisten
/permissionsGETBerechtigungsstatus (Bildschirmaufnahme, Bedienungshilfen)

Maus & Tastatur (erfordert Bedienungshilfen-Berechtigung)

EndpunktMethodeBeschreibung
/mouse/positionGETAktuelle Mausposition
/mouse/movePOSTMaus bewegen
/mouse/clickPOSTMausklick ausführen
/mouse/dragPOSTDrag-Operation ausführen
/keyboard/typePOSTText zeichenweise eingeben
/keyboard/keyPOSTEinzelne Taste drücken
/keyboard/hotkeyPOSTTastenkombination drücken

Sonstiges

EndpunktMethodeBeschreibung
/legal/:typeGETRechtliche Texte (impressum, terms, privacy, accessibility)
/logsGET/DELETEProtokolle abrufen/löschen
/docsGETSwagger-UI Dokumentation
/openapi.jsonGETOpenAPI-Spezifikation
/quitPOSTApp beenden

Beispiel

# Texterfassung per API starten
curl http://localhost:9876/capture

# Verlauf abrufen
curl http://localhost:9876/history

# Mit Authentifizierung
curl -H "Authorization: Bearer mein-token" \
     http://localhost:9876/history