mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
1.1 KiB
1.1 KiB
description
| description |
|---|
| Convert a Markdown file to a Word document (DOCX). |
Markdown to Word
Convert a Markdown file to a Word document (DOCX), preserving headings, lists, code blocks, and other formatting.
API Endpoint
POST /api/v1/tools/files/markdown-to-docx
Accepts multipart form data with a Markdown file.
Parameters
This tool has no configurable parameters. Upload a Markdown file and it will be converted to DOCX.
Example Request
curl -X POST http://localhost:1349/api/v1/tools/files/markdown-to-docx \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@README.md"
Example Response
{
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/README.docx",
"originalSize": 4500,
"processedSize": 18200
}
Notes
- Accepted input formats:
.md,.markdown. - This is a fast (synchronous) tool that returns the result directly.
- Headings, bold, italic, links, code blocks, and lists are mapped to Word styles.
- Conversion is handled by Pandoc on the server.