← Tools Reference

ScreenshotOne

ScreenshotOne integration (Developer Tools, Design & Media). Imported from open-connector.

API key5 toolshttps://api.screenshotone.com
POST
screenshotone_take_screenshot
Take a ScreenshotOne screenshot from a website URL, HTML, or Markdown source.

/take

14 parameters
ParamTypeRequiredDescription
urlstringoptionalThe website URL to render. Exactly one of url, html, or markdown is required.
htmlstringoptionalThe raw HTML content to render. Exactly one of url, html, or markdown is requir…
markdownstringoptionalThe Markdown content to render. Exactly one of url, html, or markdown is requir…
cachebooleanoptionalWhether ScreenshotOne should return or reuse a cached screenshot URL.
delayintegeroptionalThe delay in seconds before rendering the screenshot.
formatstringoptionalThe output format for the screenshot.
response_typestringoptionalThe response type requested from ScreenshotOne.
block_adsbooleanoptionalWhether to block ads while rendering the screenshot.
block_chatsbooleanoptionalWhether to block chat widgets while rendering the screenshot.
block_cookie_bannersbooleanoptionalWhether to block cookie banners while rendering the screenshot.
dark_modebooleanoptionalWhether to enable dark mode during rendering.
viewport_widthintegeroptionalThe viewport width in pixels.
viewport_heightintegeroptionalThe viewport height in pixels.
device_scale_factornumberoptionalThe viewport device scale factor.
POST
screenshotone_take_animated_screenshot
Take an animated ScreenshotOne capture as a video or GIF file.

/animate

37 parameters
ParamTypeRequiredDescription
urlstringrequiredThe website URL to capture as an animation.
delayintegeroptionalThe delay in milliseconds before recording begins.
widthintegeroptionalThe output width in pixels.
heightintegeroptionalThe output height in pixels.
formatstringoptionalThe animation output format.
durationintegeroptionalThe animation duration in seconds.
scenariostringoptionalThe animation scenario.
block_adsbooleanoptionalWhether to block ads during capture.
full_pagebooleanoptionalWhether to capture the full scrollable page.
scroll_byintegeroptionalThe pixels to scroll per step.
clip_xintegeroptionalThe X coordinate for GIF clipping.
clip_yintegeroptionalThe Y coordinate for GIF clipping.
clip_widthintegeroptionalThe GIF clip width in pixels.
clip_heightintegeroptionalThe GIF clip height in pixels.
scroll_backbooleanoptionalWhether to scroll back to the top after scrolling.
aspect_ratiostringoptionalThe output aspect ratio string.
scroll_delayintegeroptionalThe delay between scroll steps in milliseconds.
scroll_easingstringoptionalThe easing to use for scrolling animations.
viewport_widthintegeroptionalThe viewport width in pixels.
omit_backgroundbooleanoptionalWhether to omit the background. Only supported for MOV output.
scroll_completebooleanoptionalWhether to stop recording when scrolling completes.
scroll_durationintegeroptionalThe duration of each scroll in milliseconds.
viewport_heightintegeroptionalThe viewport height in pixels.
scroll_start_delayintegeroptionalThe delay before scrolling begins in milliseconds.
device_scale_factornumberoptionalThe device scale factor.
scroll_to_end_afterintegeroptionalScroll to the end after the specified duration in milliseconds.
scroll_try_navigatebooleanoptionalWhether to navigate while scrolling and record the new page.
block_cookie_bannersbooleanoptionalWhether to block cookie banners during capture.
scroll_till_selectorstringoptionalScroll until the CSS selector becomes visible.
scroll_back_algorithmstringoptionalThe algorithm used when scrolling back.
scroll_navigate_afterintegeroptionalNavigate after the specified duration in milliseconds.
scroll_navigate_to_urlstringoptionalThe URL to navigate to while recording the animation.
scroll_start_immediatelybooleanoptionalWhether scrolling should start immediately.
scroll_back_after_durationintegeroptionalScroll back after the specified duration in milliseconds.
scroll_navigate_link_hintsarrayoptionalThe link text hints used when selecting a navigation target.
scroll_stop_after_durationintegeroptionalStop scrolling after the specified duration in milliseconds.
scroll_till_selector_adjust_topintegeroptionalAdjust the top selector position in pixels.
POST
screenshotone_take_bulk_screenshots
Submit multiple ScreenshotOne screenshot requests in a single bulk call.

/bulk

4 parameters
ParamTypeRequiredDescription
executebooleanoptionalWhether ScreenshotOne should execute all requests immediately.
optionsobjectoptionalThe default ScreenshotOne bulk screenshot options.
optimizebooleanoptionalWhether to optimize same-site bulk execution. Requires execute=true.
requestsarrayrequiredThe list of individual bulk screenshot requests.
GET
screenshotone_list_devices
List the ScreenshotOne device presets available for viewport emulation.

/devices

GET
screenshotone_get_usage
Retrieve the current ScreenshotOne plan usage and concurrency information.

/usage