API & Automatisierung
PDF Content Search bietet eine umfangreiche Programmierschnittstelle für die Integration mit Automatisierungs-Skripten, KI-Assistenten und eigenen Anwendungen.
REST API
Der integrierte HTTP-Server stellt über 70 Endpunkte unter http://127.0.0.1:44477/api/v1/ bereit. Die API deckt folgende Bereiche ab:
- Suche: Volltextsuche, Dokumenttext, Metadaten, Batch-Export
- Ordner: Ordner auflisten, Inhalte anzeigen, Verarbeitungsstatus
- Dokumente: Metadaten, Thumbnails, OCR-Bounding-Boxes, Neu-Verarbeitung
- Einstellungen: Lesen und Ändern von App-Einstellungen
- UI-Steuerung: Navigation, Zoom, Seitenwechsel, Filter, Sortierung, Screenshot
- Mobile Sync: Status verbundener Geräte, Synchronisation auslösen
- Cloud: Cloud-Verarbeitungsstatus und -steuerung
Die vollständige API-Dokumentation ist interaktiv verfügbar unter http://127.0.0.1:44477/api/v1/docs. Die OpenAPI-Spezifikation kann unter http://127.0.0.1:44477/api/v1/openapi.yaml abgerufen werden.
Authentifizierung
In Release-Builds ist ein Bearer-Token erforderlich. Dieser wird unter Einstellungen → Weitere Optionen → API-Server konfiguriert. Die Endpunkte /health und /docs sind ohne Authentifizierung erreichbar.
curl -H "Authorization: Bearer IHR_TOKEN" \
http://127.0.0.1:44477/api/v1/search \
-d '{"query": "Rechnung 2024"}'MCP (Model Context Protocol)
Für die Integration mit KI-Assistenten wie Claude unterstützt die App das Model Context Protocol (MCP) über JSON-RPC 2.0 am Endpunkt /mcp. Es stehen 19 Tools zur Verfügung:
| Kategorie | Tools |
|---|---|
| Suche | search_documents, get_document_text, get_document_metadata, export_documents |
| Ordner | list_folders, list_folder_contents, get_processing_status |
| UI-Steuerung | ui_navigate, ui_select_document, ui_search, get_ui_state, ui_screenshot |
| Dateien | open_in_finder, open_document_external, get_document_thumbnail |
| Verarbeitung | reprocess_document, rescan_folder |
| Konfiguration | get_app_status, get_settings |
MCP verwendet die gleiche Bearer-Token-Authentifizierung wie die REST API.
Anwendungsbeispiele
- Automatisierungs-Skripte: Dokumente per REST API durchsuchen und Ergebnisse weiterverarbeiten
- KI-Assistenten: Claude oder andere LLMs können über MCP direkt auf Ihre Dokumente zugreifen
- Eigene Integrationen: Über die OpenAPI-Spezifikation können Client-Bibliotheken generiert werden