/api/v1/documents/{slug}/exportExport a page
Downloads a page as portable Markdown (md), a Word document (docx, one page), one self-contained HTML file (html), or a .zip with its images (zip). With subpages=true its sub-pages come too, in a .zip. comments includes the comment threads for someone who can see them: a Comments section in Markdown, margin comments or footnotes in Word. Editors can always export; readers can unless the page turns exporting off.
Guide: Export a page
Code samples and Try itPath parameters
#slugstringRequiredThe document's address: the part after
markdrop.in/.
Query parameters
#formatstringmd(the default),docx,htmlorzip. One ofmd,html,zip,docx. One ofmd,html,zip,docx. Default"md".subpagesbooleanInclude its sub-pages (not with
docx). Defaultfalse.commentsstringfootnotesormargin(Word); any of them gives Markdown its Comments section. Not for HTML. One ofnone,footnotes,margin. One ofnone,footnotes,margin.comment_statusstringopenorall(the default). One ofopen,all. One ofopen,all. Default"all".
Headers
#X-Read-PasswordstringThe password of a password-protected document.
X-Edit-SecretstringThe document's edit secret (
sk_…), for a document published without an account. See Edit key.X-Markdrop-WorkspacestringA workspace's id: answer only if the document is in that workspace, else
404. Workspace domains send it; you rarely need it.
Responses
#200OK.413Too many pages to export at once.422The document is end-to-end encrypted: export it from the page in your browser.429Too many requests from your IP address. Wait the seconds inRetry-After.