MH MediaHarvester Web Context API

Markdown

Scrape Markdown

Convert a live webpage into clean markdown for agents and RAG.

GET /v1/web/scrape/markdown

What you get

Developer-ready output for Scrape Markdown

01 LLM-readable markdown
02 includeLinks and includeImages controls
03 Main-content extraction
04 Base64 image shortening

How it works

Four steps from request to usable JSON

1

Send URL and markdown options

2

Fetch or render the page

3

Remove boilerplate when requested

4

Return markdown and source URL

API response

Fields developers usually wire first

Convert webpages to clean, LLM-ready Markdown with links, images and freshness controls.

markdown url links images
curl.exe -H "X-API-Key: mh-localhost-dev-key" "http://127.0.0.1:8013/v1/web/scrape/markdown"

Developer FAQ

Common questions about Scrape Markdown

12 answers
Why use Markdown for LLMs?

Markdown keeps headings, lists, tables and links while removing most layout noise. It is easier to chunk and cheaper to place in a model context than raw HTML.

Can I preserve links for citations?

Yes. Keep includeLinks enabled when your agent needs source links or when downstream answers should cite the original page.

Can I exclude navigation and footers?

Yes. useMainContentOnly tells the extractor to focus on the article or page body and skip repeated chrome where possible.

What endpoint should I call for Scrape Markdown?

Use GET /v1/web/scrape/markdown. Local development accepts the X-API-Key header with mh-localhost-dev-key, and production clients can use the same shape with their own key.

Can I call it from CLI, SDK, MCP and no-code tools?

Yes. The same endpoint can be called with curl, the TypeScript SDK, Python SDK, MCP server, Zapier, Make, n8n, Google Sheets or Excel workflows where appropriate.

How does caching with maxAgeMs work?

When maxAgeMs is supported, a cached response can be reused if it is younger than the requested freshness window. Set maxAgeMs to 0 when you need a fresh scrape or extraction.

What happens when a page is blocked or requires login?

The API returns clear states such as blocked, verification_required, login_required, robots_disallowed or permission_required. It does not promise to bypass access controls.

Which response fields should I store?

Most integrations store markdown, url, links, images, plus source URL, status, confidence and timestamp fields when present. Keep source metadata so users can audit values later.

Can I batch this endpoint?

For local or small workflows, loop over a list of URLs or domains. For larger jobs, use crawl, batch workflow endpoints or a queue so failures and retries are tracked cleanly.

How should I handle errors in production?

Check success, HTTP status, error.type and retryable flags. Retry timeouts and temporary network failures, but do not retry robots, login or permission errors without changing input or authorization.

Does the API work with JavaScript-heavy sites?

The engine router starts with fast fetching and escalates when content quality is low. Browser-style rendering is used where available, while access-control barriers are reported explicitly.

Is this safe to use with customer data?

Send only domains, URLs or fields your workflow needs. Use retention controls for generated artifacts and avoid storing unnecessary raw HTML, screenshots or extracted personal data.

Related data APIs

Build the next step in the workflow