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

Files

T

SnapOtterandGitHub ecc0a45f0e docs: per-tool reference pages for all 157 tools (+ fix docs build) (#261 )

* fix(docs): keep gray-matter on js-yaml 3 so the docs site builds

The js-yaml >=4.2.0 override from #257 forced js-yaml 4 onto gray-matter (used by vitepress and vitepress-plugin-llms), which calls the removed yaml.safeLoad and broke `vitepress build`. Scope a gray-matter>js-yaml ^3.14.1 override so gray-matter keeps the v3 API (build-time, trusted frontmatter only) while app code stays on js-yaml 4.2.0+.

* docs: add per-tool reference pages for all 157 tools, with a modality sidebar

Generate /tools/<id> pages for the 104 tools that lacked one (video 29, audio 17, document 36, data 10, and 12 newer image tools), matching the existing page format (API endpoint, parameters from the OpenAPI spec, curl example, response, notes). Async/AI tools document the 202+SSE flow and feature-bundle requirement.

Sidebar: add Video / Audio / PDF & Documents / Data groups with per-tool links, fold the 12 new image tools into the existing image categories, and replace the placeholder rest.md-anchor group. Docs site builds cleanly (157 pages, no dead links).

2026-06-17 11:11:37 +08:00

1.8 KiB

Raw Blame History

description

description
Extract text from PDF documents using AI-powered OCR.

PDF OCR

Extract text from PDF documents using AI-powered optical character recognition. Supports multiple quality tiers and languages. Requires the OCR feature bundle to be installed.

API Endpoint

POST /api/v1/tools/ocr-pdf

Accepts multipart form data with a PDF file and an optional JSON settings field.

Parameters

Parameter	Type	Required	Default	Description
quality	string	No	`"balanced"`	OCR quality tier: `fast`, `balanced`, `best`
language	string	No	`"auto"`	Document language: `auto`, `en`, `de`, `fr`, `es`, `zh`, `ja`, `ko`
pages	string	No	`"all"`	Page selection, e.g. `"all"`, `"1-3"`, `"1,3,5"`

Example Request

curl -X POST http://localhost:1349/api/v1/tools/ocr-pdf \
  -H "Authorization: Bearer si_your-api-key" \
  -F "file=@scanned.pdf" \
  -F 'settings={"quality": "best", "language": "en", "pages": "1-5"}'

Example Response

Returns 202 Accepted. Track progress via SSE at /api/v1/jobs/{jobId}/progress.

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "async": true
}

Notes

Accepted input format: .pdf.
This is an AI tool that requires the OCR feature bundle to be installed. If the bundle is not installed, the API returns 501 Not Implemented.
The fast quality tier uses a lighter model for quicker processing; best uses a more accurate model at the cost of speed.
The auto language setting attempts to detect the document language automatically.
You can target specific pages using ranges ("1-3"), comma-separated lists ("1,3,5"), or "all" for every page.
For PDFs that already contain selectable text, consider using the faster PDF to Text tool instead.

1.8 KiB Raw Blame History