MH MediaHarvester Web Context API

Screenshot

Website Screenshot

Generate viewport or full-page screenshots for previews and audits.

GET /v1/web/screenshot

What you get

Developer-ready output for Website Screenshot

01 Viewport or full-page capture
02 Desktop and mobile sizes
03 Cookie popup handling
04 Generated asset URL

How it works

Four steps from request to usable JSON

1

Send URL and viewport

2

Render the page

3

Capture screenshot

4

Return image URL and dimensions

API response

Fields developers usually wire first

Capture up-to-date website screenshots for demos, audits, monitoring and reports.

screenshot screenshotType width height
curl.exe -H "X-API-Key: mh-localhost-dev-key" "http://127.0.0.1:8013/v1/web/screenshot"

Developer FAQ

Common questions about Website Screenshot

12 answers
Can I capture a full page?

Yes. Use full_page or fullScreenshot mode when you need the entire scrollable page rather than the initial viewport.

Can I capture mobile layouts?

Yes. Pass viewport width and height for mobile, tablet or custom breakpoints.

What if a cookie popup covers the page?

Enable cookie popup handling. The worker attempts common consent buttons but will not bypass login or verification walls.

What endpoint should I call for Website Screenshot?

Use GET /v1/web/screenshot. 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 screenshot, screenshotType, width, height, 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