View as Markdown
HTML to Image icon

HTML to Image ACTION

Convert URL to Image

Capture a screenshot from a URL. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's HTML to Image account once, then configure and run Convert URL to Image 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: "html_to_image-convert-url-to-image",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    html_to_image: { authProvisionId: "apn_xxxxxxx" },
    url: "URL",
    viewPortWidth: 10,
  },
})

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.

Convert URL to Image inputs
Property Type Description
url URL string
The URL of the webpage
Required
viewPortWidth View Port Width integer
Width of View Port. Default value is 1080
Optional
viewPortHeight View Port Height integer
Height of View Port. Default value is 720
Optional
quality Quality integer
Quality of the image should be in the range 30-100. Default value is 30.
Optional
fullPage Full Page boolean
Whether to capture full-page screenshot of the URL. Default value is false.
Optional
waitUntil Wait Until integer
Number of seconds to wait before capturing a screenshot from the URL. Default value is 0
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
html_to_image-convert-url-to-image
Version
0.0.2
App
HTML to Image
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes