Dataczar
Browse helpers

API Reference / web / page-markdown

Generate a Markdown snapshot for any page.

Fetches the requested URL (or uses inline HTML) and returns a Markdown document with the page title, URL, meta description, and the extracted body text wrapped as readable paragraphs. Perfect for saving web research into notebooks or help docs.

GETPOST/web/page-markdown

Where this helper shines

Generate a Markdown snapshot for any page. keeps web helpers on autopilot. Use it whenever you need to generate a Markdown snapshot for any page without pausing a sprint or asking design/dev to jump in.

  • Trigger this helper whenever you need to generate a Markdown snapshot for any page without waiting on a full deploy.
  • Drop it into automations (Zapier, Make, workers) to generate a Markdown snapshot for any page as part of your workflow.
  • Share the GET URL so support and success can generate a Markdown snapshot for any page safely using their Dataczar API key.

Copy & ship snippets

GET

Instant link

GET https://api.dataczar.app/web/page-markdown?url=https%3A%2F%2Fexample.com%2Fsample.png&timeout=20&dryrun=true&ak=demo

Open directly in any browser, webhook, or low-code workflow.

curl

curl GET

curl "https://api.dataczar.app/web/page-markdown?url=https%3A%2F%2Fexample.com%2Fsample.png&timeout=20&dryrun=true&ak=demo"

Swap ak=demo with your Dataczar API key.

curl

curl POST

curl -X POST "https://api.dataczar.app/web/page-markdown?ak=demo" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/sample.png",
  "html": "<p>Example</p>",
  "timeout": 30,
  "dryrun": true
}'

Send JSON payloads from back-end jobs, queues, or workers.

Parameters

Query Parameters

NameTypeDescription
urlstringPage to fetch when you don't send `html`.
timeoutnumberRequest timeout in seconds (default 5s).
dryrunbooleanReturn a summary instead of fetching.

All helper calls accept your Dataczar key via the ak query parameter. Need one? Create or copy a key on Dataczar Connect and drop it into each request.

Responses

Status 200

JSON envelope containing the Markdown output.

{
  "ok": true,
  "data": {
    "result": {
      "markdown": "# Dataczar Helpers\\n\\n_Source: https://build.dataczar.com/helpers_\\n\\n## Extracted Text\\n\\nDataczar Helpers make it easy...",
      "metadata": {
        "title": "Dataczar Helpers",
        "domain": "build.dataczar.com"
      }
    }
  },
  "meta": {
    "service": "web/page-markdown"
  }
}

Examples

Test Contracts

[
  {
    "name": "markdown_inline",
    "method": "POST",
    "body": {
      "html": "<html><h1>Launch</h1><p>Markdown export</p></html>"
    },
    "expect": {
      "ok": true
    }
  }
]

Query parameters

Body parameters

We'll send these as JSON for POST/PUT/PATCH requests and as query params for GET.

Equivalent curl
Grab your Dataczar API key
Every helper runs with the same simple API key. Sign in (or create a free Dataczar account) at Dataczar Connect to issue keys in seconds, then drop the key into any `ak=` parameter and start shipping.
Get your API keyBrowse helpers
Tip: reuse the same key across these helpers, or rotate keys per project from the Connect dashboard.