Get Screenshot
AI-generatedSummary
Captures a screenshot of the specified URL via the ScreenshotBase API and returns the image as binary data.
Inputs
- url (required) — The URL to capture
- fileName — Name for the screenshot file; default: screenshot.png
- advanced.block_ads — Whether to block ads on the page; default: false
- advanced.block_chats — Whether to block chat widgets on the page; default: false
- advanced.block_cookie_banners — Whether to block cookie banners on the page; default: false
- advanced.styles — Custom CSS injected before screenshot (will be URL‑encoded); default: empty
- advanced.delay — Seconds to wait before taking the screenshot; default: 0 (range 0‑30)
- advanced.format — Image format to return; options: gif, jpeg, jpg, png, webp; default: png
- advanced.full_page — Whether to capture the full page; default: false
- advanced.hide_selectors — Comma‑separated CSS selectors to hide; default: empty
- advanced.ip_country_code — ISO 3166‑1 alpha‑2 country code for the outgoing request; default: empty
- advanced.quality — Image quality (1‑100) for jpg/jpeg; default: 80
- advanced.timeout — Page load timeout in seconds; default: 60 (range 5‑60)
- advanced.viewport_height — Height of the browser viewport in pixels; default: 800
- advanced.viewport_width — Width of the browser viewport in pixels; default: 1280
- advanced.wait_until — When to take the screenshot based on page load state; options: domcontentloaded, load, networkidle0, networkidle2; default: load
- requestOptions.allowUnauthorizedCerts — Whether to accept insecure SSL certificates; default: false
- requestOptions.proxy — HTTP proxy to use for the request; default: empty
- requestOptions.timeout — Request timeout in milliseconds; default: 10000
- requestOptions.batching.batchSize — Items per batch for throttling; -1 disables, 0 treated as 1; default: 50
- requestOptions.batching.batchInterval — Milliseconds between batches; default: 1000
Output shape
binary
The captured screenshot image; file name taken from the File Name parameter
Examples
Example 1: Capture a full‑page PNG of https://example\.com
url: https://example.com, advanced.full_page: true, fileName: example.png