mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
docs: audit all 157 tool pages against live schemas
Reconcile every tool page's parameters, defaults, and response shape against the tool's Zod settings schema and executionHint in code. Notable fixes: color-palette (add count + format params, hex output, median-cut algorithm), favicon (add 5 params, was documented as having none), qr-generate (add logoDataUri), convert (add ppm/eps/tga formats), video-loudnorm (-16 LUFS not -14), smart-crop (async 202 not sync 200), images-to-video (1080x1080 square), and several output-filename and behavior-note corrections. Also normalize API endpoint paths to /api/v1/tools/<id> (no modality segment) and standardize curl examples on the Docker API port 1349. Verified with a clean docs build.
This commit is contained in:
@@ -1,10 +1,14 @@
|
||||
---
|
||||
description: Extract text from images using AI-powered optical character recognition.
|
||||
---
|
||||
|
||||
# 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/image/ocr`
|
||||
`POST /api/v1/tools/ocr`
|
||||
|
||||
**Processing:** Synchronous (returns extracted text directly, though progress is reported via SSE if a `clientJobId` is provided)
|
||||
|
||||
@@ -23,7 +27,7 @@ Extract text from images using AI-powered optical character recognition. Support
|
||||
## Example Request
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:13490/api/v1/tools/image/ocr \
|
||||
curl -X POST http://localhost:1349/api/v1/tools/ocr \
|
||||
-F "file=@document.png" \
|
||||
-F 'settings={"quality":"best","language":"en","enhance":true}'
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user