跳转到内容
Escriba Suite Escriba Suite

API

Escriba 暴露了一个小巧的 REST API，便于自动化（n8n、脚本）。身份验证 始终是必需的。

身份验证

Section titled “身份验证”

使用 API token（定义 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"

使用会话 cookie：

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

转换

Section titled “转换”

POST /api/convert（multipart/form-data）：file 或 url，外加可选的 lang、 ocr、pages、llm_provider、llm_api_key、llm_model。响应：

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

涂黑

Section titled “涂黑”

POST /api/redact（multipart/form-data）：file（PDF 或图片），可选的 lang、 anon_strict、anon_detectors、anon_rules。返回涂黑版 PDF（二进制）， 并通过 X-Redacted-Entities 响应头统计被涂黑的内容数量。

Markdown 后处理

Section titled “Markdown 后处理”

输入 JSON，输出 JSON 或文件：

端点方法说明
/api/exportPOST将 Markdown 转换为目标格式（docx、odt、epub、html、latex、rst、docbook、jats、tei、opml）。
/api/compactPOST剥除空白的 Markdown，以节省 token。
/api/chunkPOSTtoken 受限的 RAG 块（返回 .jsonl）。
/api/model_pricesGET实时模型定价与上下文窗口（OpenRouter，已缓存）。