Files
SnapOtter/apps/docs/tools/files/convert-document.md
T
SnapOtterandGitHub 00b651c9f8 feat(i18n): 21-language pipeline, landing/docs/API wiring, landing+API translations
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.
2026-07-11 13:01:55 +08:00

1.3 KiB

description
description
Convert between Word, OpenDocument, RTF, and plain text formats.

Convert Document

Convert documents between Word (DOCX), OpenDocument (ODT), RTF, and plain text formats using LibreOffice.

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

Parameter Type Required Default Description
format string Yes - Output format: docx, odt, rtf, txt

Example Request

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

Returns 202 Accepted. Track progress via SSE at /api/v1/jobs/{jobId}/progress.

{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "async": true
}

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.