Screenshot
Website Screenshot
Freeze what a page looked like at request time so teams can review visual state without asking someone to open the URL and reproduce it later.
/v1/web/screenshot
What you get
Developer-ready output for Website Screenshot
Real workflows
Where teams use Website Screenshot
These examples map to the endpoint's current inputs and outputs—not hypothetical platform features.
Capture the page while collecting metadata or styleguide signals and include it in a client report.
Store periodic screenshots for important pages alongside content or metadata checks.
Render a page thumbnail for account research, link review or content moderation workflows.
How it works
4 concrete steps from input to result
Send URL and viewport
Render the page
Capture screenshot
Return image URL and dimensions
API response
Fields developers usually wire first
Capture current website screenshots with viewport and full-page controls for visual QA, client reports, monitoring and evidence workflows.
curl.exe -H "X-API-Key: YOUR_API_KEY" "http://127.0.0.1:8013/v1/web/screenshot"
Developer FAQ
Common questions about Website Screenshot
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 YOUR_API_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
POST /v1/web/crawl
Scrape HTML
Fetch page HTML for DOM inspection, structured extraction, migration tooling and debugging, with rendering escalation when a static response is not enough.
GET /v1/web/scrape/html
Scrape Markdown
Convert webpages into clean, source-linked Markdown for AI agents, research notes and retrieval pipelines while keeping link and image controls explicit.
GET /v1/web/scrape/markdown
Meta Title and Description
Extract title, description, canonical, language, Open Graph and Twitter metadata for SEO QA, link previews and lightweight URL enrichment.
GET /v1/web/meta
Scrape Images
Discover page images across img, picture, lazy-loading, CSS backgrounds, inline SVG and video poster sources, then normalize them into usable media records.
GET /v1/web/scrape/images
Royalty-Free Image Finder
Search curated stock-image providers for reusable visual candidates, with provider and license context kept alongside every result.
POST /v1/royalty-free-images/search
Image OCR
Extract text from screenshots, scans and image files through a Paddle-first OCR chain with structured line output and a local fallback engine.
POST /v1/ocr/json
YouTube Transcript
Retrieve timestamped YouTube transcript text through multiple local fallback methods for research, indexing and content analysis.
POST /v1/youtube/transcript