View as Markdown
screenshotbase icon

screenshotbase ACTION

Take a Screenshot

Take a screenshot with ScreenshotBase. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's screenshotbase account once, then configure and run Take a 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: "screenshotbase-take-screenshot",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    screenshotbase: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    format: "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.

Take a Screenshot inputs
Property Type Description
url URL string
Website to render
Required
format Format string
The format of the image returned
Required
filename Target Filename string
The filename (including extension) that will be used to save the file in /tmp
Required
quality Quality integer
The quality of the image returned. Only supported when the format is jpg or jpeg
Optional
fullPage Full Page boolean
Whether to take a screenshot of the full page
Optional
viewportWidth Viewport Width integer
The width of the browser viewport in pixels. The browser's viewport is the window area where you can see the website. Default value is 1280.
Optional
viewportHeight Viewport Height integer
The height of the browser viewport in pixels. The browser's viewport is the window area where you can see the website. Default value is 800.
Optional
syncDir SyncDir dir
Required

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
screenshotbase-take-screenshot
Version
0.0.1
App
screenshotbase
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes