get_screenshot
Scrape a URL using ScrapingBee and return it's screenshot.
Scope: one URL per call, with the result returned into the conversation.
For many URLs, a whole site, output written to a file or directory,
resumable jobs, or a scheduled re-run, use the ScrapingBee CLI instead —
scrapingbee scrape --input-file urls.txt --output-dir results,
scrapingbee crawl URL --save-pattern ..., scrapingbee schedule --every.
This server has no batch, crawl, file-output or scheduling equivalent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The URL of the page to scrape. | |
| wait | No | Milliseconds to wait after page load (0–35000). | |
| device | No | desktop (default) or mobile. | desktop |
| cookies | No | Semicolon-separated cookies to send to the target. | |
| timeout | No | Request timeout in milliseconds (1000–140000, default 140000). | |
| wait_for | No | CSS or XPath selector to wait for before returning. | |
| render_js | No | Whether to use headless-browser rendering. | |
| session_id | No | Integer 0–10000000 to reuse an IP for up to 5 minutes. | |
| js_scenario | No | Stringified JSON object of browser interaction instructions. | |
| country_code | No | ISO 3166-1 alpha-2 country code (e.g. "fr", "us") to route the request through an IP in that country. Only takes effect when premium_proxy or stealth_proxy is True. | |
| wait_browser | No | domcontentloaded (default), load, networkidle0, networkidle2. | domcontentloaded |
| window_width | No | Viewport width (default 1920). | |
| custom_google | No | Set to True if the url is a google domain in the following format: <subdomain>.google.<top-level-domain> (Example: translate.google.com, mail.google.com, www.google.co.in etc) | |
| json_response | No | Deprecated, removed in Version 3. Return the full JSON envelope (page content plus the base64 image under its "screenshot" key) instead of the raw image. | |
| premium_proxy | No | Whether to use a premium proxy for the request. Use it only if you are getting blocked by the website, that is when you get a 500 status code. | |
| stealth_proxy | No | Whether to use a stealth proxy for the request. Use it only if you are getting blocked by the website while using premium_proxy, that is when you get a 500 status code. | |
| window_height | No | Viewport height (default 1080). | |
| block_resources | No | Block images/CSS to speed up rendering. | |
| screenshot_selector | No | A CSS selector to take a screenshot of a specific element. | |
| screenshot_full_page | No | Whether to take a screenshot of the full page or just the viewport. |