Zum Hauptinhalt springen

API & Automation

PDF Content Search provides a comprehensive programming interface for integration with automation scripts, AI assistants and custom applications.

REST API

The built-in HTTP server provides over 70 endpoints at http://127.0.0.1:44477/api/v1/. The API covers the following areas:

  • Search: Full-text search, document text, metadata, batch export
  • Folders: List folders, view contents, processing status
  • Documents: Metadata, thumbnails, OCR bounding boxes, reprocessing
  • Settings: Read and modify app settings
  • UI Control: Navigation, zoom, page switching, filters, sorting, screenshot
  • Mobile Sync: Connected device status, trigger synchronization
  • Cloud: Cloud processing status and control

The full API documentation is available interactively at http://127.0.0.1:44477/api/v1/docs. The OpenAPI specification can be retrieved at http://127.0.0.1:44477/api/v1/openapi.yaml.

Authentication

In release builds, a Bearer token is required. Configure it under Settings → More Options → API Server. The /health and /docs endpoints are accessible without authentication.

curl -H "Authorization: Bearer YOUR_TOKEN" \
     http://127.0.0.1:44477/api/v1/search \
     -d '{"query": "invoice 2024"}'

MCP (Model Context Protocol)

For integration with AI assistants like Claude, the app supports the Model Context Protocol (MCP) via JSON-RPC 2.0 at the /mcp endpoint. 19 tools are available:

CategoryTools
Searchsearch_documents, get_document_text, get_document_metadata, export_documents
Folderslist_folders, list_folder_contents, get_processing_status
UI Controlui_navigate, ui_select_document, ui_search, get_ui_state, ui_screenshot
Filesopen_in_finder, open_document_external, get_document_thumbnail
Processingreprocess_document, rescan_folder
Configget_app_status, get_settings

MCP uses the same Bearer token authentication as the REST API.

Use Cases

  • Automation scripts: Search documents via REST API and process results further
  • AI assistants: Claude or other LLMs can access your documents directly via MCP
  • Custom integrations: Client libraries can be generated from the OpenAPI specification