API reference

Every endpoint lives under /v1 and speaks JSON, except conversion responses, which return the converted file directly.

Authentication

Pass your key as a bearer token. Keys are created in the dashboard and scoped per project.

Authorization: Bearer wm_live_8f2a...

Convert a single file

POST /v1/convert accepts a multipart form with three fields.

FieldTypeNotes
fromstringdocx, md, html, pdf
tostringdocx, md, html, pdf
filebinary50 MB maximum
curl -X POST https://word.bvrdo.online/v1/convert \
  -H "Authorization: Bearer $WORDMILL_KEY" \
  -F "from=docx" -F "to=markdown" \
  -F "file=@report.docx" -o report.md

Batch jobs

POST /v1/batch queues up to 200 files and returns a job id. Poll GET /v1/batch/{id} until state becomes done, then download the archive.

Errors

StatusCodeMeaning
400unsupported_pairThat from/to combination is not available
401invalid_keyKey missing, revoked or malformed
413file_too_largeUpload exceeded the plan limit
429rate_limitedRetry after the seconds given in Retry-After
503renderer_busyTransient; safe to retry with backoff

Versioning

Renderer versions are pinned per project. We publish a new version roughly every quarter and keep the previous two available for at least twelve months.