Files
SnapOtter/apps/docs/tools/files/convert-document.md
T

47 lines
1.3 KiB
Markdown
Raw Normal View History

---
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}
2026-06-21 00:12:59 +08:00
`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
2026-06-21 00:12:59 +08:00
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.