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.
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
---
|
|
description: Convert between Word, OpenDocument, RTF, and plain text formats.
|
|
---
|
|
|
|
# Convert Document {#convert-document}
|
|
|
|
Convert documents between Word (DOCX), OpenDocument (ODT), RTF, and plain text formats using LibreOffice.
|
|
|
|
## API Endpoint {#api-endpoint}
|
|
|
|
`POST /api/v1/tools/files/convert-document`
|
|
|
|
Accepts multipart form data with a Word/ODT/RTF/TXT file and a JSON `settings` field.
|
|
|
|
## Parameters {#parameters}
|
|
|
|
| Parameter | Type | Required | Default | Description |
|
|
|-----------|------|----------|---------|-------------|
|
|
| format | string | Yes | - | Output format: `docx`, `odt`, `rtf`, `txt` |
|
|
|
|
## Example Request {#example-request}
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/files/convert-document \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@report.docx" \
|
|
-F 'settings={"format": "odt"}'
|
|
```
|
|
|
|
## 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`, `.doc`, `.odt`, `.rtf`, `.txt`.
|
|
- Conversion is handled by LibreOffice running headless on the server.
|
|
- Complex formatting (macros, embedded objects) may not survive conversion between formats.
|
|
- The output format must differ from the input format.
|