Ir al contenido

API

Escriba expone una pequeña API REST, práctica para la automatización (n8n, scripts). La autenticación siempre es obligatoria.

Con un token de API (defina API_TOKEN):

Ventana de terminal
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 una cookie de sesión:

Ventana de terminal
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 o url, más los opcionales lang, ocr, pages, llm_provider, llm_api_key, llm_model. Respuesta:

{ "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 imagen), opcionales lang, anon_strict, anon_detectors, anon_rules. Devuelve el PDF censurado (binario) con la cabecera X-Redacted-Entities que cuenta lo que se tachó.

JSON de entrada, JSON o archivo de salida:

EndpointMétodoDescripción
/api/exportPOSTConvertir Markdown a un formato de destino (docx, odt, epub, html, latex, rst, docbook, jats, tei, opml).
/api/compactPOSTMarkdown sin espacios en blanco para ahorrar tokens.
/api/chunkPOSTFragmentos RAG acotados por tokens (devuelve .jsonl).
/api/model_pricesGETPrecios de modelos y ventanas de contexto en vivo (OpenRouter, en caché).