View as Markdown
ScreenshotOne icon

ScreenshotOne ACTION

Take Animated Screenshot

Takes and returns an animated screenshot of the given site with specified options. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ScreenshotOne account once, then configure and run Take Animated Screenshot from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "screenshotone-take-animated-screenshot",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    screenshotone: { authProvisionId: "apn_xxxxxxx" },
    websiteUrl: "Website URL",
    fileName: "File name",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Take Animated Screenshot inputs
Property Type Description
websiteUrl Website URL string
The URL of the website to take a screenshot of
Required
fileName File name string
The new name of the file to be saved without extension. e.g: screenshot
Required
scenario Scenario string
The default scenario is to record animation after loading the site without additional animations. See the documentation
Required
viewportWidth Viewport Width integer
The width of the viewport for the screenshot
Required
viewportHeight Viewport Height integer
The height of the viewport for the screenshot
Required
format Format string
The format of the screenshot
Required
scrollDelay Scroll Delay integer
Delay in milliseconds between scrolls. The default value is 500
Optional
scrollDuration Scroll Duration integer
Duration in milliseconds of one scroll. The default value is 1500
Optional
scrollBy Scroll By integer
By how many pixes scroll. The default value is 1000
Optional
blockCookieBanners Block Cookie Banners boolean
Whether to block cookie banners in the screenshot
Optional
blockAds Block Ads boolean
Whether to block ads in the screenshot
Optional
blockTrackers Block Trackers boolean
Whether to block trackers in the screenshot
Optional
delay Delay integer
The delay before taking the screenshot, in seconds
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
screenshotone-take-animated-screenshot
Version
0.0.3
App
ScreenshotOne
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes