URL → Markdown

POST /v1/url/to-markdown  ·  1¢

Renders a URL with a real Chromium instance — JavaScript-heavy pages included — and converts the result to GitHub-flavoured Markdown: tables, links (made absolute), and basic formatting are preserved. Scripts, styles and navigation chrome are stripped before conversion.

Parameters

Name	Type	Description
url	string	http(s) URL to fetch. Required.
selector	string	CSS selector to extract only part of the page. Default body.
includeTitle	boolean	Prepend the page title as an H1. Default true.
waitUntil	string	load or networkidle0 (default).
delayMs	integer	Extra wait after load, in ms (max 10000). Optional.
output	string	md (file, default) or json → {markdown, title, url}.

Example request

curl -X POST https://api.bigapi.dev/v1/url/to-markdown \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","output":"json"}'

Example response

{
  "markdown": "# Example Domain\n\nThis domain is for use in illustrative examples...",
  "title": "Example Domain",
  "url": "https://example.com",
  "_meta": { "op": "url.to-markdown", "durationMs": 812.5 }
}

Related guides