API URL
POST /api/v1/markdown-convert/to-html, /to-markdown, /to-text, /outline, /batch (POST), /capabilities (GET)
Headers
Code
Content-Type: application/jsonBody Parameters
Param
Type
Description
markdown
required
string
Markdown source document
html
required
string
HTML source document
allowRawHtml
optional
boolean
Send embedded raw HTML through the sanitizer instead of escaping it (default false)
headingIds
optional
boolean
Assign unique slug ids to headings (default true)
linkify
optional
boolean
Autolink bare URLs (default true)
breaks
optional
boolean
Render single newlines as line breaks (default false)
typographer
optional
boolean
Smart quotes and dashes (default false)
footnotes
optional
boolean
Enable footnote syntax (default true)
taskLists
optional
boolean
Enable task list syntax (default true)
headingStyle
optional
string
Markdown heading style atx or setext (default atx)
bulletMarker
optional
string
Unordered list marker - * or + (default -)
codeBlockStyle
optional
string
Code block style fenced or indented (default fenced)
linkStyle
optional
string
Link style inlined or referenced (default inlined)
emphasisDelimiter
optional
string
Emphasis delimiter _ or * (default _)
strongDelimiter
optional
string
Strong delimiter ** or __ (default **)
includeCodeBlocks
optional
boolean
Keep code block contents in plaintext (default true)
includeLinkUrls
optional
boolean
Append the URL after link text in plaintext (default false)
includeImages
optional
boolean
Keep image alt text in plaintext (default true)
wrap
optional
number
Plaintext wrap width 0-200 where 0 disables wrapping (default 0)
listMarker
optional
string
Plaintext bullet marker - * or + (default -)
tableDelimiter
optional
string
Plaintext table-cell delimiter (default tab)
includeHeadingMarkers
optional
boolean
Include heading markers in plaintext (default false)
tocMinLevel
optional
number
Minimum heading level included in the outline table of contents (1-6 default 1)
tocMaxLevel
optional
number
Maximum heading level included in the outline table of contents (1-6 default 6)
documents
required
array
Batch documents 1-25 each with a target and its own parameters
id
optional
string
Caller supplied document id echoed in batch results
target
required
string
Conversion target html markdown text or outline
Example Request
Code
POST https://datpaq.com/api/v1/markdown-convert/to-html?api_key=your-api-key | Body: {"markdown":"# Release Notes"}Successful Response
Status
HTML
200 OKBody
Code
{"success":true,"html":"<h1 id=\"release-notes\">Release Notes</h1>
","frontMatter":null,"headings":[{"level":1,"text":"Release Notes","slug":"release-notes","line":1}],"stats":{"inputBytes":16,"durationMs":2}}Field
Type
success
boolean
html
string
markdown
string
text
string
frontMatter
object
footnotes
array
headings
array
outline
array
toc
array
links
array
images
array
codeBlocks
array
languages
array
wordCount
number
readingTimeMinutes
number
results
array
summary
object
stats
object
correlationId
string
metadata
object
updatedAt
string
processingTime
string
Error Response
Example
Code
HTTP 400 ValidationError: Missing unknown or invalid body field — Request rejected before conversion; HTTP 400 InvalidJson: Request body is not valid JSON — Body parser rejected the payload before routing; HTTP 401 AuthenticationError: Gateway authentication failure — Request rejected due to missing or invalid API credentials; HTTP 404 NotFound: Unknown endpoint path — Request path does not map to available markdown-convert routes; HTTP 413 PayloadTooLarge: Field over the input byte limit or body over the transport limit — Document too large to convert; HTTP 422 UnprocessableEntity: Malformed YAML front matter — Document front matter could not be parsed; HTTP 429 RateLimitError: More than 120 requests in 15 minutes — Request rejected by service rate limiter; HTTP 500 InternalError: Stage time budget exceeded or unexpected failure — Conversion could not completeLast Updated: May 4, 2026