Salta ai contenuti

API

Escriba espone una piccola API REST, comoda per l’automazione (n8n, script). L’autenticazione è sempre obbligatoria.

Con un token API (definisci API_TOKEN):

Terminal window
curl -H "X-API-Key: YOUR_TOKEN" \
-F "file=@document.pdf" \
https://your-domain/api/convert
# Force OCR / set language: -F "ocr=true" -F "lang=es-ES"

Con un cookie di sessione:

Terminal window
curl -c cookies.txt -F "password=$GOD_PASSWORD" https://your-domain/api/login
curl -b cookies.txt -F "file=@document.pdf" https://your-domain/api/convert

POST /api/convert (multipart/form-data): file oppure url, più gli opzionali lang, ocr, pages, llm_provider, llm_api_key, llm_model. Risposta:

{ "source": "", "title": "", "markdown": "",
"words": 1234, "chars": 5678, "elapsed_ms": 87,
"pdf_type": "scanned", "ocr_applied": true, "note": null }

POST /api/redact (multipart/form-data): file (PDF o immagine), opzionali lang, anon_strict, anon_detectors, anon_rules. Restituisce il PDF redatto (binario) con l’header X-Redacted-Entities che conta ciò che è stato oscurato.

JSON in ingresso, JSON o file in uscita:

EndpointMetodoDescrizione
/api/exportPOSTConverti il Markdown in un formato di destinazione (docx, odt, epub, html, latex, rst, docbook, jats, tei, opml).
/api/compactPOSTMarkdown con gli spazi rimossi per risparmiare token.
/api/chunkPOSTChunk RAG limitati per token (restituisce .jsonl).
/api/model_pricesGETPrezzi dei modelli e finestre di contesto in tempo reale (OpenRouter, in cache).