View as Markdown
GetScreenshot icon

GetScreenshot ACTION

Get Website Screenshot

Capture a screenshot from a live website. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's GetScreenshot account once, then configure and run Get Website 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: "getscreenshot-get-website-screenshot",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    getscreenshot: { authProvisionId: "apn_xxxxxxx" },
    url: "Website URL",
    format: "Image Format",
  },
})

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.

Get Website Screenshot inputs
Property Type Description
url Website URL string
URL of the website / page you want to screenshot. Should start with http:// or https://
Required
format Image Format string
The file type/format in which you want to get your capture. If pdf is selected, an A4 PDF of the passed website will be generated, rendered the same as if you were printing it from your browser.
Optional
email Email Address string
If specified, a formatted email will be sent to this email address, including the captured image and details of the capture.
Optional
element Element string
If you need to target specific DOM elements instead of taking dimension-based screenshots, you can specify an element DOM selector, e.g. #colordiv to target a div with the id "colordiv".
Optional
additionalParams Additional Parameters object
Additional parameters (key/value pairs) to send in this request. See the documentation for all available parameters.
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
getscreenshot-get-website-screenshot
Version
0.0.3
App
GetScreenshot
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes