Pular para o conteúdo

API

O Escriba expõe uma pequena API REST, útil para automação (n8n, scripts). A autenticação é sempre obrigatória.

Com um token de API (defina 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"

Com um cookie de sessão:

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 ou url, mais os opcionais lang, ocr, pages, llm_provider, llm_api_key, llm_model. Resposta:

{ "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 ou imagem), opcionais lang, anon_strict, anon_detectors, anon_rules. Retorna o PDF tarjado (binário) com o cabeçalho X-Redacted-Entities contando o que foi tarjado.

JSON na entrada, JSON ou arquivo na saída:

EndpointMétodoDescrição
/api/exportPOSTConverte o Markdown para um formato de destino (docx, odt, epub, html, latex, rst, docbook, jats, tei, opml).
/api/compactPOSTMarkdown sem espaços em branco para economizar tokens.
/api/chunkPOSTFragmentos para RAG limitados por tokens (retorna .jsonl).
/api/model_pricesGETPreços de modelos e janelas de contexto ao vivo (OpenRouter, em cache).