convert

Clean, repair, and convert markdown

Runs the markdown through the requested pipeline (clean / repair) and renders to the requested output format. Charges 1 credit per successful render; failures are refunded automatically.

post/api/v1/convert

Request

  • Base URL: https://mdtidy.com
  • URL: https://mdtidy.com/api/v1/convert
  • Auth: API key in header X-API-KEY

Request body

markdownstring required

The markdown source to convert. UTF-8. Hard cap: 1 MB.

format'html' | 'text' | 'pdf' | 'docx' | 'png' required

Output format.

designSystem'minimal-clean' | 'executive-report' | 'developer-docs'

Slug of a built-in design system. Defaults to minimal-clean. An unknown slug returns 400 unknown_design_system. Available: minimal-clean (Minimal Clean), executive-report (Executive Report), developer-docs (Technical Doc).

Response

Conversion succeeded.

format'html' | 'text' | 'pdf' | 'docx' | 'png' required
contentTypestring required
byteSizeinteger required
designSystemstring required
outputstring

Inline body for text/HTML outputs.

outputBase64string

Base64-encoded body for binary outputs (PDF/DOCX/PNG).

creditsChargedinteger required
creditsRemaininginteger required
requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.