---
canonical_url: "https://docs.composio.dev/toolkits/snaprender"
markdown_url: "https://docs.composio.dev/toolkits/snaprender.md"
product: "platform"
version: null
last_updated: null
---

# SnapRender

Capture websites as images or PDFs, extract rendered web content, and manage batches, usage, and scheduled captures.

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 24
- **Triggers:** 0
- **Slug:** `SNAPRENDER`
- **Version:** 00000000_00

## Tools

### Capture Page

**Slug:** `SNAPRENDER_CAPTURE_PAGE`

Render a URL, HTML, or Markdown document as a PNG, JPEG, WebP, or PDF file using POST. Choose this action for HTML, Markdown, native JSON request values, or custom target headers; CAPTURE_PAGE_GET is the URL-only query-compatible variant. A fresh render consumes one capture credit; a matching cached result is free. When click_selector is provided, the click can submit forms, trigger navigation, or otherwise cause potentially irreversible target-site side effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public HTTP(S) page to render; provide exactly one of url, html, or markdown. |
| `html` | string | No | Raw HTML to render, up to 2 MB; provide exactly one source. |
| `cache` | boolean | No | Reuse a matching cached capture when available. |
| `delay` | integer | No | Milliseconds to wait after the page loads before capture. |
| `width` | integer | No | Viewport width in pixels. |
| `device` | string ("iphone_14" | "iphone_15_pro" | "pixel_7" | "ipad_pro" | "macbook_pro") | No | Optional device preset for viewport and browser emulation. |
| `format` | string ("png" | "jpeg" | "webp" | "pdf") | No | Output file format. |
| `height` | integer | No | Viewport height in pixels. |
| `headers` | object | No | Up to 10 sensitive custom target-page headers for URL captures; reserved browser headers are rejected. Header values may contain up to 1024 characters. Do not log or disclose header values. |
| `quality` | integer | No | JPEG or WebP quality from 1 to 100. |
| `markdown` | string | No | Markdown to render, up to 500 KB; provide exactly one source. |
| `metadata` | boolean | No | Embed the software name and full source URL in PNG, JPEG, or PDF metadata when true; strip them when false. |
| `block_ads` | boolean | No | Block common advertising requests during rendering. |
| `cache_ttl` | integer | No | Requested cache lifetime in seconds; the account plan may cap it. |
| `dark_mode` | boolean | No | Emulate a dark color scheme. |
| `full_page` | boolean | No | Capture the full scrollable page instead of only the viewport. |
| `lazy_load` | boolean | No | Scroll through the page to load lazy content before capture; mainly useful with full_page. |
| `user_agent` | string | No | Custom browser User-Agent for the target page. |
| `response_type` | string ("binary" | "json") | No | Provider response representation. Both choices return an offloaded downloadable file from this action. |
| `click_selector` | string | No | CSS selector for one element to click before capture. The click can submit forms, trigger navigation, or otherwise cause target-site side effects. |
| `hide_selectors` | string | No | CSS selectors for elements to hide before capture. |
| `block_cookie_banners` | boolean | No | Attempt to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Capture Page (GET)

**Slug:** `SNAPRENDER_CAPTURE_PAGE_GET`

Render a public URL as a PNG, JPEG, WebP, or PDF file using the URL-only GET query variant for query-compatible clients. Use CAPTURE_PAGE instead for HTML, Markdown, native JSON request values, or custom target headers. If the result is not cached, the render consumes one capture credit. A matching cached result is free. If click_selector is provided, SnapRender clicks the matching element before capture; that click can submit forms, trigger navigation, or otherwise cause potentially irreversible target-site side effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) page to render. |
| `cache` | boolean | No | Reuse a matching cached capture when available. |
| `delay` | integer | No | Milliseconds to wait after the page loads before capture. |
| `width` | integer | No | Viewport width in pixels. |
| `device` | string ("iphone_14" | "iphone_15_pro" | "pixel_7" | "ipad_pro" | "macbook_pro") | No | Optional device preset for viewport and browser emulation. |
| `format` | string ("png" | "jpeg" | "webp" | "pdf") | No | Output file format. |
| `height` | integer | No | Viewport height in pixels. |
| `quality` | integer | No | JPEG or WebP quality from 1 to 100. |
| `metadata` | boolean | No | Embed the software name and full source URL in PNG, JPEG, or PDF metadata when true; pass false to strip that metadata. |
| `block_ads` | boolean | No | Block common advertising requests during rendering. |
| `cache_ttl` | integer | No | Requested cache lifetime in seconds; the account plan may cap it. |
| `dark_mode` | boolean | No | Emulate a dark color scheme. |
| `full_page` | boolean | No | Capture the full scrollable page instead of only the viewport. |
| `lazy_load` | boolean | No | Scroll through the page to load lazy content before capture. |
| `user_agent` | string | No | Custom browser User-Agent for the target page. |
| `response_type` | string ("binary" | "json") | No | Provider response representation. Both choices return an offloaded downloadable file from this action. |
| `click_selector` | string | No | CSS selector for one element to click before capture. The click can submit forms, trigger navigation, or otherwise mutate the target page. |
| `hide_selectors` | string | No | CSS selectors for elements to hide before capture. |
| `block_cookie_banners` | boolean | No | Attempt to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Agent Trial

**Slug:** `SNAPRENDER_CREATE_AGENT_TRIAL`

Create a limited SnapRender trial API key for an AI agent without signup. The trial provides 100 captures over seven days, at most 30 per day, and the returned key can be claimed by a human with a free account. Treat both the API key and claim URL as secrets: do not log or store them insecurely, and disclose the claim URL only to its intended owner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `agent` | string | No | Optional name of the AI agent or client requesting the trial key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Batch Capture

**Slug:** `SNAPRENDER_CREATE_BATCH_CAPTURE`

Queue asynchronous screenshots for 1 to 50 public URLs using shared render options. Each URL consumes one capture credit unless its render fails. This action returns immediately and does not poll the job. When click_selector is provided, each click can submit forms, trigger navigation, or otherwise cause potentially irreversible target-site side effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `urls` | array | Yes | Public HTTP(S) pages to capture (1-50 URLs); each URL consumes one credit unless its render fails. |
| `delay` | integer | No | Milliseconds to wait after each page loads. |
| `width` | integer | No | Shared viewport width in pixels. |
| `device` | string ("iphone_14" | "iphone_15_pro" | "pixel_7" | "ipad_pro" | "macbook_pro") | No | Optional shared device preset. |
| `format` | string ("png" | "jpeg" | "webp" | "pdf") | No | Output format shared by every item. |
| `height` | integer | No | Shared viewport height in pixels. |
| `quality` | integer | No | JPEG or WebP quality from 1 to 100. |
| `block_ads` | boolean | No | Block common advertising requests. |
| `dark_mode` | boolean | No | Emulate a dark color scheme. |
| `full_page` | boolean | No | Capture each full scrollable page. |
| `lazy_load` | boolean | No | Scroll each page to load lazy content before capture. |
| `user_agent` | string | No | Custom browser User-Agent shared by all targets. |
| `click_selector` | string | No | CSS selector for one element to click. |
| `hide_selectors` | string | No | CSS selectors for elements to hide. |
| `block_cookie_banners` | boolean | No | Attempt to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Schedule

**Slug:** `SNAPRENDER_CREATE_SCHEDULE`

Create an hourly, daily, or weekly PNG capture schedule with visual change detection. Hourly is unavailable on Free. Email notifications require Business or Scale when enabled; disabling them works on any plan. The first quota-consuming capture is queued immediately and normally runs within one minute. If click_selector is provided, every scheduled capture can cause form submission, navigation, or other potentially irreversible target-site side effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) page to capture on the schedule. |
| `name` | string | No | Optional schedule name. |
| `delay` | integer | No | Milliseconds to wait after page load. |
| `width` | integer | No | Viewport width in pixels. |
| `device` | string ("iphone_14" | "iphone_15_pro" | "pixel_7" | "ipad_pro" | "macbook_pro") | No | Optional device preset. |
| `format` | string | No | Capture format; schedules support PNG only. |
| `height` | integer | No | Viewport height in pixels. |
| `interval` | string ("hourly" | "daily" | "weekly") | Yes | Schedule frequency. Hourly is unavailable on Free; daily and weekly work on all plans. |
| `block_ads` | boolean | No | Block common advertising requests. |
| `dark_mode` | boolean | No | Emulate a dark color scheme. |
| `full_page` | boolean | No | Capture the full scrollable page. |
| `lazy_load` | boolean | No | Scroll to load lazy content before each capture. |
| `user_agent` | string | No | Custom browser User-Agent. |
| `notify_email` | boolean | No | Whether visual changes trigger an account-owner email. True requires Business or Scale; false works on any plan. |
| `click_selector` | string | No | CSS selector for one element to click. |
| `hide_selectors` | string | No | CSS selectors for elements to hide. |
| `change_threshold` | number | No | Percentage visual difference required to mark a capture as changed. |
| `block_cookie_banners` | boolean | No | Attempt to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `SNAPRENDER_CREATE_WEBHOOK`

Create a signed SnapRender webhook subscription for selected events at an HTTPS endpoint. An account can have at most five webhooks. The returned signing secret is needed to verify deliveries; store it securely and do not log or disclose it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTPS endpoint that will receive SnapRender webhook deliveries. |
| `events` | array | Yes | One or more SnapRender events to deliver to the webhook. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Schedule

**Slug:** `SNAPRENDER_DELETE_SCHEDULE`

Permanently delete a capture schedule and all of its stored captures.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `schedule_id` | string | Yes | Caller-owned schedule to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `SNAPRENDER_DELETE_WEBHOOK`

Permanently delete a webhook subscription so future events are no longer delivered to its URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Caller-owned webhook subscription to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Embed Screenshot

**Slug:** `SNAPRENDER_EMBED_SCREENSHOT`

Render a keyless 1280x800 thumbnail of a web page as a downloadable image. SnapRender refreshes each variant at most once per day, so repeated calls use its daily cache. Fresh renders share a daily budget; when that budget is exhausted, SnapRender returns a neutral placeholder image instead of an error.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTP(S) page to render as a 1280x800 thumbnail. |
| `dark` | integer | No | Set to 1 to request dark color-scheme rendering; omit to disable it. |
| `format` | string ("png" | "webp") | No | Optional output format. Omit to use SnapRender's undocumented default. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Page Content

**Slug:** `SNAPRENDER_EXTRACT_PAGE_CONTENT`

Render a web page and extract its Markdown, text, HTML, article data, links, or metadata using a POST JSON body with native boolean and integer values. Prefer this action for programmatic JSON calls; EXTRACT_PAGE_CONTENT_GET is the query-parameter compatibility variant. A fresh extraction consumes one capture credit; a matching cached result is free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) page to render and extract. |
| `type` | string ("markdown" | "text" | "html" | "article" | "links" | "metadata") | No | Content representation to return. |
| `cache` | boolean | No | Reuse a matching cached extraction when available. |
| `delay` | integer | No | Milliseconds to wait after page load before extraction. |
| `selector` | string | No | Optional CSS selector that limits extraction to matching content. |
| `block_ads` | boolean | No | Block common advertising requests while rendering. |
| `cache_ttl` | integer | No | Requested cache lifetime in seconds; the connected account's plan may cap it. |
| `max_length` | integer | No | Maximum extracted content length. |
| `block_cookie_banners` | boolean | No | Attempt to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Extract Page Content (GET)

**Slug:** `SNAPRENDER_EXTRACT_PAGE_CONTENT_GET`

Render a public web page and extract its Markdown, text, HTML, article data, links, or metadata using the GET query-parameter compatibility variant. Use EXTRACT_PAGE_CONTENT instead for a POST JSON body with native boolean and integer values. A fresh extraction consumes one capture credit; a matching cached result is free.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) page to render and extract. |
| `type` | string ("markdown" | "text" | "html" | "article" | "links" | "metadata") | No | Content representation to return. |
| `cache` | boolean | No | Reuse a matching cached extraction when available. |
| `delay` | integer | No | Milliseconds to wait after page load before extraction. |
| `selector` | string | No | Optional CSS selector that limits extraction to matching content. |
| `block_ads` | boolean | No | Block common advertising requests while rendering. |
| `cache_ttl` | integer | No | Requested cache lifetime in seconds; the connected account's plan may cap it. |
| `max_length` | integer | No | Maximum extracted content length in characters. |
| `block_cookie_banners` | boolean | No | Attempt to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Batch Capture

**Slug:** `SNAPRENDER_GET_BATCH_CAPTURE`

Get an asynchronous batch capture's progress, item results, and completed download URLs. Completed URLs are sensitive presigned download credentials that expire after 24 hours; do not log or disclose them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Batch job ID returned by Create Batch Capture. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Schedule

**Slug:** `SNAPRENDER_GET_SCHEDULE`

Get one capture schedule's definition, render options, activity state, failure state, and run timestamps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `schedule_id` | string | Yes | Schedule ID returned by Create Schedule or List Schedules. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Screenshot Info

**Slug:** `SNAPRENDER_GET_SCREENSHOT_INFO`

Check whether a URL, format, and viewport variant is cached without capturing the page or consuming quota.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | HTTP(S) page whose screenshot cache status to check. |
| `width` | integer | No | Viewport width in pixels for the resolution-specific cache entry. |
| `format` | string ("png" | "jpeg" | "webp" | "pdf") | No | Output format whose format-specific cache entry to check. |
| `height` | integer | No | Viewport height in pixels for the resolution-specific cache entry. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage

**Slug:** `SNAPRENDER_GET_USAGE`

Return either the current plan and remaining capture quota or bounded daily capture counts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `days` | integer | No | Daily lookback length from 1 to 90 days. Use only with view='daily'; when omitted, SnapRender defaults to 30 days. |
| `view` | string ("summary" | "daily") | No | Choose current quota summary or daily capture counts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Health Check

**Slug:** `SNAPRENDER_HEALTH_CHECK`

Check SnapRender service health, including Chromium, Redis, and database connectivity.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Schedule Captures

**Slug:** `SNAPRENDER_LIST_SCHEDULE_CAPTURES`

Return one page of a schedule's capture history, change results, and one-hour download URLs. These URLs are sensitive presigned download credentials; do not log or disclose them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum captures to return in this page. |
| `cursor` | string | No | Continuation cursor from the previous response; returns captures older than this timestamp. |
| `schedule_id` | string | Yes | Schedule whose capture history to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Schedules

**Slug:** `SNAPRENDER_LIST_SCHEDULES`

List capture schedules and the account's schedule eligibility, retention, and capacity limits.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `SNAPRENDER_LIST_WEBHOOKS`

List all webhook subscriptions for the authenticated SnapRender account, including their event subscriptions and signing secrets. Treat returned signing secrets as sensitive and do not log them.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Render Signed Screenshot

**Slug:** `SNAPRENDER_RENDER_SIGNED_SCREENSHOT`

Render a signed screenshot as a downloadable image or PDF. Recommended: pass the complete signed_url returned by SIGN_SCREENSHOT_URL directly. Direct callers may instead provide all four documented url, expires, key_prefix, and sig components plus any signed capture options. Every option is covered by the signature and must be preserved. Never log or disclose signed components. Each render consumes one capture credit from the signing account. Signed options can include click_selector, which may submit forms or cause other irreversible target-site effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sig` | string | No | Sensitive sig query value from the signed_url returned by SIGN_SCREENSHOT_URL. Pass it exactly as issued; do not log, store, or disclose it. |
| `url` | string | No | Sensitive url query value from the signed_url returned by SIGN_SCREENSHOT_URL. Pass it exactly as issued; do not log, store, or disclose it. |
| `delay` | integer | No | Signed delay after page load in milliseconds, from 0 to 10000. |
| `width` | integer | No | Signed viewport width in pixels, from 320 to 3840. |
| `device` | string ("iphone_14" | "iphone_15_pro" | "pixel_7" | "ipad_pro" | "macbook_pro") | No | Signed device preset for mobile, tablet, or laptop emulation. |
| `format` | string ("png" | "jpeg" | "webp" | "pdf") | No | Signed output format. Pass exactly the value embedded by SIGN_SCREENSHOT_URL. |
| `height` | integer | No | Signed viewport height in pixels, from 200 to 10000. |
| `expires` | string | No | Sensitive expires query value from the signed_url returned by SIGN_SCREENSHOT_URL. Pass it exactly as issued; do not log, store, or disclose it. |
| `quality` | integer | No | Signed JPEG or WebP image quality from 1 to 100. |
| `block_ads` | boolean | No | Signed choice to block common advertising requests. |
| `dark_mode` | boolean | No | Signed choice to emulate a dark color scheme. |
| `full_page` | boolean | No | Signed choice to capture the entire scrollable page. |
| `lazy_load` | boolean | No | Signed choice to scroll a full page so lazy-loaded images appear. |
| `key_prefix` | string | No | Sensitive key_prefix query value from the signed_url returned by SIGN_SCREENSHOT_URL. Pass it exactly as issued; do not log, store, or disclose it. |
| `signed_url` | string | No | Recommended: pass the complete sensitive signed_url returned by SIGN_SCREENSHOT_URL. It is parsed locally and never fetched, forwarded, logged, stored, or disclosed. |
| `user_agent` | string | No | Signed custom browser User-Agent for the target page. |
| `click_selector` | string | No | Signed CSS selector for one element to click before capture. |
| `hide_selectors` | string | No | Signed CSS selectors for elements to hide before capture. |
| `block_cookie_banners` | boolean | No | Signed choice to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Schedule Now

**Slug:** `SNAPRENDER_RUN_SCHEDULE_NOW`

Queue an immediate, quota-consuming capture for an active schedule; the capture normally runs within one minute. Each call queues another capture, so this action is non-idempotent. The run executes the schedule's stored render options: a stored click_selector can submit forms, navigate, or cause other potentially irreversible target-site side effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `schedule_id` | string | Yes | Active schedule to queue for an immediate capture. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Sign Screenshot URL

**Slug:** `SNAPRENDER_SIGN_SCREENSHOT_URL`

Mint a tamper-proof URL that can render a screenshot without an API key. Signing is free, but every render consumes one capture credit. The returned URL contains sensitive signature material and must be shared only with intended recipients. If click_selector is set, every later render can cause target-site side effects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public HTTP(S) page the signed URL will capture. |
| `delay` | integer | No | Milliseconds to wait after the page loads before capture. |
| `width` | integer | No | Viewport width in pixels. |
| `device` | string ("iphone_14" | "iphone_15_pro" | "pixel_7" | "ipad_pro" | "macbook_pro") | No | Optional device preset for mobile, tablet, or laptop emulation. |
| `format` | string ("png" | "jpeg" | "webp" | "pdf") | No | Output file format. |
| `height` | integer | No | Viewport height in pixels. |
| `quality` | integer | No | JPEG or WebP image quality from 1 to 100. |
| `block_ads` | boolean | No | Block common advertising requests during rendering. |
| `dark_mode` | boolean | No | Emulate a dark color scheme. |
| `full_page` | boolean | No | Capture the entire scrollable page. |
| `lazy_load` | boolean | No | For full-page captures, scroll first so lazy-loaded images appear. |
| `expires_in` | integer | No | Signed URL validity in seconds, from 60 seconds to 30 days. |
| `user_agent` | string | No | Custom browser User-Agent for the target page. |
| `click_selector` | string | No | CSS selector for one element to click before capture. |
| `hide_selectors` | string | No | CSS selectors for elements to hide before capture. |
| `block_cookie_banners` | boolean | No | Attempt to hide common cookie consent banners. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Webhook

**Slug:** `SNAPRENDER_TEST_WEBHOOK`

Send an external test payload to a registered webhook URL and return the delivery result. This immediately makes a real, irreversible outbound delivery attempt to the external endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | string | Yes | Registered webhook to receive the external test delivery. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Schedule

**Slug:** `SNAPRENDER_UPDATE_SCHEDULE`

Rename, retime, pause, resume, or adjust change detection and lazy loading for a capture schedule. Hourly is unavailable on Free. Enabling email notifications requires Business or Scale; disabling them works on any plan. Changing lazy_load can make the next capture register as changed once. Provide at least one update field in addition to schedule_id. To explicitly exercise SnapRender's documented empty PATCH semantics without a silent no-op, set confirm_no_op=true; the returned schedule is unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New schedule name; explicitly pass null to clear it. |
| `interval` | string ("hourly" | "daily" | "weekly") | No | New schedule frequency. Hourly is unavailable on Free; daily and weekly work on all plans. |
| `is_active` | boolean | No | Set false to pause the schedule or true to resume it. |
| `lazy_load` | boolean | No | Whether future runs scroll to load lazy content. |
| `schedule_id` | string | Yes | Schedule ID returned by Create Schedule or List Schedules. |
| `notify_email` | boolean | No | Whether visual changes trigger an account-owner email. True requires Business or Scale; false works on any plan. |
| `confirm_no_op` | boolean | No | Set true only to intentionally send SnapRender's documented empty PATCH object, which returns the schedule without changing it. |
| `change_threshold` | number | No | New percentage difference required to mark a capture as changed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
