POST /v1/markup/html-to-markdown

HTML to Markdown

Headings, lists, links and tables survive; the styling and scripts do not.

Turn a web page into Markdown now No key, no code — 2 credits either way.

curl -X POST "$DOATHING_API/v1/markup/html-to-markdown" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"text": "<h1>Title</h1><p>A <a href=\"https://x.test\">link</a>.</p>"}'

Headings, lists, links and tables survive; the styling and scripts do not.

Convert HTML to CommonMark, preserving headings, lists, links, code blocks and tables.

Input

Send either a text string or a file object. A file is decoded as UTF-8 and must be one of text/html, text/plain.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "text": "# Title\n\nA [link](https://x.test).",
  "bytes": 32,
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

2 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.

Parameters

Generated from the endpoint’s own validation, so this is exactly what it accepts. A body field goes at the top level; an option goes inside options.

NameInTypeDefaultNotes
ignore_imagesoptionsbooleanfalseDrop images instead of emitting them.
ignore_linksoptionsbooleanfalseKeep link text but drop the targets.
widthoptionsinteger0Wrap column. Zero means do not wrap. 0 to 200