DocumentationAPI DetailsScrape URLTake Screenshot

Take Screenshot

Capture a full-page screenshot of the final rendered page as a PNG image. The screenshot is taken after all browser commands have executed and any captchas have been solved, giving you a visual record of exactly what was scraped.

Set includeScreenshot to true to enable this feature. The resulting PNG file is stored temporarily and a download URL is provided in the response. Screenshots require a real browser - if useBrowser is not set, it will be enabled automatically.

Each screenshot costs an additional 2 credits. See Credit Usage for details.

When To Use This

  • Visual verification - Confirm that the scraped page rendered correctly before processing the HTML content.
  • Content archival - Save visual snapshots of web pages for record-keeping, legal compliance, or historical reference.
  • Debugging browser commands - Take a screenshot to see the final state of the page after your commands execute. For full playback, consider video recording instead.
  • Visual regression monitoring - Compare screenshots over time to detect changes in website layout or content.
  • Proof of content - Capture evidence of displayed content (pricing, availability, advertisements) at a specific point in time.

Response Data

The screenshot URL appears in the JSON response:

{
  "screenshotUrl": "https://scrapi.blob.core.windows.net/[API-KEY]/[FILE].png"
}

When using HTML or Markdown format, the URL is returned in the X-ScrAPI-ScreenshotUrl header instead.

Screenshot files are stored temporarily. Download them promptly after the response.

Example Request

GET https://api.scrapi.tech/v1/scrape?url=https://deventerprise.com&useBrowser=true&includeScreenshot=true

POST https://api.scrapi.tech/v1/scrape

{
  "url": "https://deventerprise.com",
  "useBrowser": true,
  "includeScreenshot": true
}

Related Features

  • PDF Generation - Generate a PDF document instead of (or in addition to) a screenshot.
  • Video Recording - Record the full browser session for debugging or archival.
  • Browser Commands - Interact with the page before the screenshot is taken.
  • Real Browser - Required for screenshots (enabled automatically).
  • Credit Usage - Screenshots cost 2 additional credits per request.

Testing

Test this request in the Playground or view the OpenAPI specification.

Response SelectorGenerate PDF File