View as Markdown
Browserless icon

Browserless ACTION

Take a Screenshot

Take a screenshot of a page. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Browserless 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: "browserless-take-screenshot",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    browserless: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    downloadPath: "Download Path",
  },
})

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
Enter the URL you'd like to take a screenshot of here
Required
downloadPath Download Path string
Download the screenshot to the /tmp directory with the specified filename
Optional
waitForSelector Selector string
Allows you to wait for a selector to appear in the DOM. See more details in the API Doc
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
browserless-take-screenshot
Version
0.5.6
App
Browserless
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes