View as Markdown
Rendex icon

Rendex ACTION

Render to Image

Render an HTML string or a page URL to an image (or PDF) via Rendex. Returns base64-encoded image data with metadata. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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.

Render to Image inputs
Property Type Description
html HTML string
The HTML markup to render to an image.
Optional
url URL string
A page URL to render (alternative to HTML). Provide either html or url.
Optional
format Output Format string
Output file format. Example values: png, jpeg, webp, or pdf.
Optional
width Width integer
Viewport width in pixels (320–3840). Defaults to 1280.
Optional
height Height integer
Viewport height in pixels (240–2160). Defaults to 800.
Optional
fullPage Full Page boolean
Capture the entire scrollable page instead of just the viewport.
Optional
quality Quality integer
Image quality from 1–100 (JPEG/WebP only).
Optional
delay Delay (ms) integer
Milliseconds to wait after the page settles before capturing (0–10000).
Optional
darkMode Dark Mode boolean
Emulate prefers-color-scheme: dark when rendering.
Optional
deviceScaleFactor Device Scale Factor string
Pixel density multiplier from 1 to 3 (e.g. 2 for retina). Defaults to 2.
Optional
device Device string
Device preset that sets viewport size, scale, and user agent in one shot. Explicit width/height/user agent still win.
Optional
selector Selector string
Capture only the element matching this CSS selector instead of the whole page.
Optional
hideSelectors Hide Selectors string[]
CSS selectors for elements to hide (display: none) before capture — e.g. cookie banners, popups, sticky nav.
Optional
blockAds Block Ads boolean
Block known ad/tracker network requests. Enabled by default.
Optional
blockCookieBanners Block Cookie Banners boolean
Hide common cookie/consent walls (OneTrust, Cookiebot, Quantcast, …) via a curated CSS list.
Optional
timeout Timeout (seconds) integer
Maximum time to wait for the page to load (5–60). Defaults to 30.
Optional
waitUntil Wait Until string
Navigation lifecycle event to wait for before capturing.
Optional
bestAttempt Best Attempt boolean
Return a partial capture on timeout instead of erroring. Enabled by default.
Optional
css Custom CSS string
CSS injected into the page before capture (up to 50KB).
Optional
js Custom JavaScript string
JavaScript executed in the page before capture (up to 50KB).
Optional
userAgent User Agent string
Override the browser User-Agent header.
Optional
cookies Cookies string[]
Cookies to set before loading the page. Each item is a JSON object, e.g. {"name":"session","value":"abc","domain":"example.com"}. Requires a Starter plan or higher.
Optional
headers Headers object
Extra HTTP request headers to send with the page load, as a JSON object of key–value pairs, e.g. { "Accept-Language": "de-DE", "X-Debug": "1" }. Requires a Starter plan or higher.
Optional
pdfFormat PDF Format string
Paper size for PDF output (ignored for image formats).
Optional
pdfLandscape PDF Landscape boolean
Render the PDF in landscape orientation.
Optional
pdfPrintBackground PDF Print Background boolean
Include background graphics and colors in the PDF.
Optional
pdfScale PDF Scale string
PDF render scale from 0.1 to 2. Defaults to 1.
Optional
geo Geo Country string
Two-letter country code (e.g. US, DE) to capture from via a geo-targeted proxy. Pro/Enterprise only.
Optional
geoCity Geo City string
City to target for the geo proxy. Pro/Enterprise only.
Optional
geoState Geo State string
State/region to target for the geo proxy. Pro/Enterprise only.
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
rendex-render-to-image
Version
0.1.0
App
Rendex
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes