mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtter
8532f3227b
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.
44 lines
1016 B
Markdown
44 lines
1016 B
Markdown
---
|
|
description: Convert Word, Markdown, HTML, or plain text files to EPUB.
|
|
---
|
|
|
|
# Convert to EPUB
|
|
|
|
Convert Word documents, Markdown, HTML, or plain text files into the EPUB e-book format.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/to-epub`
|
|
|
|
Accepts multipart form data with a Word/Markdown/HTML/TXT file.
|
|
|
|
## Parameters
|
|
|
|
This tool has no configurable parameters. Upload a document and it will be converted to EPUB.
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/to-epub \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@manuscript.docx"
|
|
```
|
|
|
|
## Example Response
|
|
|
|
Returns `202 Accepted`. Track progress via SSE at `/api/v1/jobs/{jobId}/progress`.
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"async": true
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Accepted input formats: `.docx`, `.md`, `.html`, `.txt`.
|
|
- The EPUB output follows the EPUB 3 specification.
|
|
- Headings in the source document are used to generate the table of contents.
|
|
- Conversion is handled by Pandoc on the server.
|