View as Markdown
CaptureKit icon

CaptureKit ACTION

Capture Screenshot

Capture a high-quality image of any webpage. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CaptureKit account once, then configure and run Capture 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: "capturekit-capture-screenshot",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    capturekit: { 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.

Capture Screenshot inputs
Property Type Description
url URL string
Target webpage to capture
Required
format Format string
The output format of the screenshot
Optional
device Device string
Device type used for emulation (desktop or mobile)
Optional
cache Cache boolean
Enable or disable response caching
Optional
fullPageScroll Full Page Scroll boolean
Scroll through the entire page before capturing
Optional
fileName File Name string
Name of the screenshot file that will be saved on /tmp
Required
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
capturekit-capture-screenshot
Version
0.0.2
App
CaptureKit
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes