Snap Kit icon

Snap Kit

Consume Snap Kit API

Actions2

Take Snapshot

AI-generated

Overview

This node captures a snapshot (screenshot) of a specified URL using the Snap Kit API. It is useful for scenarios where you need to programmatically capture visual representations of web pages, such as for monitoring website changes, archiving content, or generating previews. For example, you can capture a full-page screenshot of a product page to include in reports or capture a viewport-sized screenshot of a landing page for marketing purposes.

Use Case Examples

  1. Capture a full-page screenshot of a news article URL to archive the content visually.
  2. Take a viewport screenshot of a dashboard URL to include in automated status reports.

Properties

Name Meaning
URL The URL to capture (must be a valid URI)
Browser Width Width of the viewport (minimum 375 pixels)
Browser Height Height of the viewport (minimum 500 pixels)
Screenshot Quality Screenshot quality from 1 to 100
Operation Timeout Timeout in seconds for the operation (between 10 and 120 seconds)
Full Page Whether to capture the full page or just the viewport
Sync Whether to wait for the capture to complete before responding

Output

JSON

  • url - The URL that was captured
  • width - The width of the viewport used for the snapshot
  • height - The height of the viewport used for the snapshot
  • quality - The quality setting used for the screenshot
  • fullPage - Indicates if the full page was captured
  • sync - Indicates if the operation was synchronous
  • timeout - The timeout setting used for the operation
  • snapshotData - The resulting snapshot data or metadata returned from the Snap Kit API

Dependencies

  • Snap Kit API accessed via an API key credential

Troubleshooting

  • Ensure the URL is a valid and accessible URI to avoid request failures.
  • Timeout errors may occur if the page takes too long to load; adjust the timeout parameter accordingly.
  • If the snapshot quality is too low, increase the quality parameter but note it may increase processing time.
  • If the node is set to asynchronous (sync=false), the snapshot may not be immediately available; handle accordingly in downstream logic.

Links

Discussion