mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

SnapOtter 7db6bb97da docs: add per-tool API documentation and fix parity gaps

- Create 53 per-tool VitePress documentation pages with accurate
  parameters from Zod schemas, example requests, and response formats
- Add root llms.txt for LLM-friendly repo browsing
- Fix OpenAPI spec: add auth and 422 error schemas to
  edit-metadata/inspect and strip-metadata/inspect sub-routes
- Fix tool count inconsistency (52 -> 53) across landing site,
  e2e tests, and local docs
- Rename color-adjustments.ts to adjust-colors.ts to match tool ID
- Update VitePress sidebar with all 8 tool categories and top nav

2026-06-08 11:52:28 +08:00

2.1 KiB

Raw Blame History

OCR / Text Extraction

Extract text from images using AI-powered optical character recognition. Supports multiple languages and quality tiers.

API Endpoint

POST /api/v1/tools/ocr

Processing: Synchronous (returns extracted text directly, though progress is reported via SSE if a clientJobId is provided)

Model bundle: ocr (3-4 GB)

Parameters

Parameter	Type	Required	Default	Description
file	file	Yes	-	Image file (multipart)
quality	string	No	`"balanced"`	Quality tier: `fast` (Tesseract), `balanced` (PaddleOCR v5), `best` (PaddleOCR VL)
language	string	No	`"auto"`	Language hint: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko`
enhance	boolean	No	`true`	Pre-process image for better OCR accuracy
engine	string	No	-	Deprecated. Use `quality` instead. Maps `tesseract` to `fast`, `paddleocr` to `balanced`

Example Request

curl -X POST http://localhost:13490/api/v1/tools/ocr \
  -F "file=@document.png" \
  -F 'settings={"quality":"best","language":"en","enhance":true}'

Response (200 OK)

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "filename": "document.png",
  "text": "Extracted text content from the image...",
  "engine": "paddleocr-vl"
}

Progress (SSE, optional)

If a clientJobId is provided, progress events are streamed:

event: progress
data: {"phase":"processing","stage":"Recognizing text...","percent":50}

Notes

Requires the ocr model bundle to be installed (3-4 GB).
Unlike most AI tools, OCR returns a synchronous JSON response with extracted text (not an image download URL).
Uses a fallback chain: if a higher-quality tier crashes (e.g., PaddleOCR segfault), it automatically retries with the next lower tier.
If a tier returns empty text without crashing, it also falls back to the next tier.
Quality tiers map to engines: fast = Tesseract, balanced = PaddleOCR v5, best = PaddleOCR VL.
Supports HEIC/HEIF, RAW, TGA, PSD, EXR, and HDR input formats via automatic decoding.

2.1 KiB Raw Blame History