GET/api/v1/documents/{slug}/export

Export 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.

Token optionalOr edit secret30 per minute per IPMCP: export_page

Guide: Export a page

Code samples and Try it

Path parameters

#
  • slugstringRequired

    The document's address: the part after markdrop.in/.

Query parameters

#
  • formatstring

    md (the default), docx, html or zip. One of md, html, zip, docx. One of md, html, zip, docx. Default "md".

  • subpagesboolean

    Include its sub-pages (not with docx). Default false.

  • commentsstring

    footnotes or margin (Word); any of them gives Markdown its Comments section. Not for HTML. One of none, footnotes, margin. One of none, footnotes, margin.

  • comment_statusstring

    open or all (the default). One of open, all. One of open, all. Default "all".

Headers

#
  • X-Read-Passwordstring

    The password of a password-protected document.

  • X-Edit-Secretstring

    The document's edit secret (sk_…), for a document published without an account. See Edit key.

  • X-Markdrop-Workspacestring

    A 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 in Retry-After.
Did this page help?