mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
00b651c9f8
Shared Claude Code translation pipeline (scripts/i18n, no API key) plus Astro/VitePress/Scalar i18n wiring. Landing and API reference translated into all 20 languages; docs i18n wiring + English source anchors. The translated docs markdown (apps/docs/<locale>/**, 3,620 files) follows in a companion PR because it exceeds GitHub's per-PR CI file limit.
44 lines
1.1 KiB
Markdown
44 lines
1.1 KiB
Markdown
---
|
|
description: Convert Word, Markdown, HTML, or plain text files to EPUB.
|
|
---
|
|
|
|
# Convert to EPUB {#convert-to-epub}
|
|
|
|
Convert Word documents, Markdown, HTML, or plain text files into the EPUB e-book format.
|
|
|
|
## API Endpoint {#api-endpoint}
|
|
|
|
`POST /api/v1/tools/files/to-epub`
|
|
|
|
Accepts multipart form data with a Word/Markdown/HTML/TXT file.
|
|
|
|
## Parameters {#parameters}
|
|
|
|
This tool has no configurable parameters. Upload a document and it will be converted to EPUB.
|
|
|
|
## Example Request {#example-request}
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/files/to-epub \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@manuscript.docx"
|
|
```
|
|
|
|
## Example Response {#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 {#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.
|