Skip to main content
ScreenshotOne logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 5
  • Triggers: 0
  • Slug: SCREENSHOTONE
  • Version: 20261101_00

Tools

Slug: SCREENSHOTONE_GET_USAGETool to retrieve current API plan usage information. Returns total requests allowed, available requests remaining, used requests count, and concurrency limits for the current billing period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCREENSHOTONE_LIST_DEVICESTool to retrieve the list of supported devices for viewport emulation. Use when you need to get available device IDs and their viewport configurations for device emulation in screenshot operations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCREENSHOTONE_TAKE_ANIMATED_SCREENSHOTThis tool captures an animated screenshot (video or GIF) of a given website URL. It allows customization of the animation format, duration, viewport dimensions, and animation scenario (e.g., scrolling).

Input Parameters

string
required
The URL of the website to capture.
integer
Delay before taking the screenshot in milliseconds. Set non-zero to allow heavy or complex pages to fully render before capture begins.
integer
Width of the output animation. If specified, height must also be specified. Defaults to viewport width. Unset or misconfigured viewport_width/viewport_height can cause cropping or distortion when width is not explicitly set.
integer
X-coordinate for clipping the video. Only for GIF format.
integer
Y-coordinate for clipping the video. Only for GIF format.
string ("mp4" | "mov" | "avi" | "webm" | "gif")
The format of the animated screenshot.
integer
Height of the output animation. If specified, width must also be specified. Defaults to viewport height.
integer
Duration of the animation in seconds. Minimum 1, maximum 30.
string ("default" | "scroll")
Defines the animation behavior. default records the site as it appears after loading. scroll simulates scrolling.
boolean
Block ads.
boolean
Capture the full scrollable page (Note: for animated, this might interact with scenario). Very long pages produce extremely tall output that may cause downstream display or storage issues.
integer
Pixels to scroll per step. Applicable if scenario is ‘scroll’.
integer
Width for clipping the video. Only for GIF format.
integer
Height for clipping the video. Only for GIF format.
boolean
Scroll back to the top after reaching the bottom. Applicable if scenario is ‘scroll’.
string
Aspect ratio for the animation (e.g., ‘16:9’). If specified, width and height are ignored.
integer
Delay in milliseconds between scrolls. Applicable if scenario is ‘scroll’.
string ("linear" | "ease_in_quad" | "ease_out_quad" | "ease_in_out_quad" | "ease_in_cubic" | "ease_out_cubic" | "ease_in_out_cubic" | "ease_in_quart" | "ease_out_quart" | "ease_in_out_quart" | "ease_in_quint" | "ease_out_quint" | "ease_in_out_quint")
Scrolling easing effect. Applicable if scenario is ‘scroll’.
integer
Viewport width.
boolean
Omit background (only for MOV format).
boolean
Stop recording animation when full scrolling is completed. Applicable if scenario is ‘scroll’.
integer
Duration in milliseconds of one scroll. Applicable if scenario is ‘scroll’.
integer
Viewport height.
integer
Wait time in milliseconds before starting scrolling. Applicable if scenario is ‘scroll’.
number
Device scale factor.
integer
Scroll to the end after the specified duration in milliseconds with the specified easing in one scroll. Applicable if scenario is ‘scroll’.
boolean
Navigate while scrolling and record the new opened page. Applicable if scenario is ‘scroll’.
Block cookie banners.
string
Scroll till the CSS selector is visible. Applicable if scenario is ‘scroll’.
string ("once" | "repeat")
Algorithm for scrolling back (once or repeat). Applicable if scenario is ‘scroll’.
integer
Navigate after duration in milliseconds (default is half of the duration). Applicable if scenario is ‘scroll’.
string
URL to navigate to. Applicable if scenario is ‘scroll’.
boolean
Scroll immediately or wait for scroll_delay. Applicable if scenario is ‘scroll’.
integer
Scroll back after the specified duration in milliseconds. Applicable if scenario is ‘scroll’.
Hints for links to use for navigation if scroll_navigate_to_url is not specified. E.g. [‘pricing’, ‘about’]. Applicable if scenario is ‘scroll’.
integer
Stop scrolling after the specified duration in milliseconds. Use with scroll_complete=false and scroll_back=false. Applicable if scenario is ‘scroll’.
integer
Adjust the top position of the selector in the viewport. Applicable if scenario is ‘scroll’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCREENSHOTONE_TAKE_BULK_SCREENSHOTSTake up to 20 screenshots in one request, with shared defaults and individual overrides. Supports lazy loading by default, or immediate execution.

Input Parameters

boolean
Execute all screenshot requests immediately instead of lazy loading. When false (default), screenshots are taken when downloaded. When true, screenshots are taken immediately.
object
Default options applied to all screenshot requests in the bulk operation.
boolean
Optimize bulk screenshots for same URLs with different parameters. Only works when execute=true. Improves performance when taking multiple screenshots of the same site.
array
required
Array of individual screenshot requests. Maximum 20 requests per bulk call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SCREENSHOTONE_TAKE_SCREENSHOTTool to generate a screenshot or PDF of a website, render HTML, or Markdown using POST request. Use when you need to capture webpage content in various formats (PNG, JPEG, WebP, PDF, HTML). Supports both returning binary content directly or getting a cached URL via JSON response.

Input Parameters

string
URL of the website to screenshot. Either url, html, or markdown must be provided.
string
HTML content to render. Either url, html, or markdown must be provided.
boolean
Set to true to get cached screenshot URL when response_type is ‘json’. The response will include a cache_url field.
integer
Delay in seconds to wait before rendering the screenshot. Must be between 0 and 30 seconds.
string ("png" | "jpeg" | "webp" | "pdf" | "html")
Output format for the screenshot.
string
Markdown content to render. Either url, html, or markdown must be provided.
boolean
Block ads on the page.
boolean
Enable dark mode for rendering the page.
boolean
Block chat widgets on the page.
string ("by_format" | "json" | "empty")
Response type for the screenshot.
integer
Viewport width of the browser in pixels.
integer
Viewport height of the browser in pixels.
integer
Device scale factor of the viewport. Must be between 1 and 5.
Block cookie banners on the page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not