mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
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.
1.1 KiB
1.1 KiB
description
| description |
|---|
| Convert a PDF to a Word document (DOCX). |
PDF to Word
Convert a text-based PDF to a Word document (DOCX). Best suited for PDFs with selectable text; scanned pages will need OCR first.
API Endpoint
POST /api/v1/tools/pdf-to-word
Accepts multipart form data with a PDF file.
Parameters
This tool has no configurable parameters. Upload a PDF and it will be converted to DOCX.
Example Request
curl -X POST http://localhost:1349/api/v1/tools/pdf-to-word \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@report.pdf"
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. - Works best with text-based PDFs. Scanned or image-only pages will produce empty or minimal output; use PDF OCR to add a text layer first.
- Conversion is handled by LibreOffice running headless on the server.
- Complex layouts (multi-column, overlapping elements) may not convert perfectly.