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

# Shotlane

Shotlane captures screenshots, renders PDFs, extracts web content, crawls sites, and monitors pages through a browser automation API.

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

## Tools

### Animate Page

**Slug:** `SHOTLANE_ANIMATE_PAGE`

Record a page or inline HTML as an MP4, WebM, or GIF and return a hosted link retained for 24 hours. Each successful recording consumes exactly 3 paid Shotlane credits; free credits do not cover video recordings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run in the page before recording; await is supported. |
| `css` | string | No | CSS to inject into the page before recording. |
| `fps` | integer | No | Frames per second from 5 through 30; Shotlane recommends 10 for GIF output. |
| `url` | string | No | Public page URL to record; provide exactly one of url or html. A successful recording consumes 3 paid Shotlane credits; free credits cannot be used. |
| `html` | string | No | Raw HTML to record; provide exactly one of url or html. A successful recording consumes 3 paid Shotlane credits; free credits cannot be used. |
| `click` | string | No | CSS selector whose first matching element should be clicked. |
| `delay` | integer | No | Extra milliseconds to wait before recording. |
| `hover` | string | No | CSS selector whose first matching element should be hovered. |
| `scale` | number | No | Device pixels per CSS pixel, from 1 through 5. |
| `width` | integer | No | Video viewport width in CSS pixels, from 240 through 1920. |
| `device` | string | No | Shotlane device preset id; explicit viewport values override the preset. |
| `format` | string ("mp4" | "webm" | "gif") | No | Video format: MP4 uses H.264, WebM uses VP9, and GIF creates an animated image. |
| `height` | integer | No | Video viewport height in CSS pixels, from 240 through 1080. |
| `locale` | string | No | Browser locale and Accept-Language value. |
| `timeout` | integer | No | Maximum page navigation time in seconds. |
| `accuracy` | number | No | Geolocation accuracy in meters when latitude and longitude are supplied. |
| `duration` | number | No | Video length in seconds, from 1 through 15. |
| `latitude` | number | No | Geolocation latitude; longitude is required with it. |
| `scenario` | string ("scroll" | "default") | No | Recording behavior: scroll moves from the top through the page; default records the page in place, such as an animation or loading sequence. |
| `timezone` | string | No | IANA time zone exposed to the page, such as America/New_York. |
| `block_ads` | boolean | No | Block advertising requests and hide their containers. |
| `dark_mode` | boolean | No | Emulate a visitor who prefers a dark color scheme. |
| `gif_width` | integer | No | GIF output width in pixels, from 200 through 1280. |
| `longitude` | number | No | Geolocation longitude; latitude is required with it. |
| `bypass_csp` | boolean | No | Ignore the target page's Content-Security-Policy for injected JavaScript. |
| `disable_js` | boolean | No | Load and record the page with JavaScript disabled. |
| `media_type` | string ("screen" | "print") | No | CSS media type applied while recording. |
| `user_agent` | string | No | User-Agent value exposed to the target page. |
| `wait_until` | string | No | One navigation load state or a sequence of states to await in order. |
| `block_chats` | boolean | No | Block chat widgets such as Intercom, Drift, and Zendesk. |
| `hide_popups` | boolean | No | Close or hide sign-in, newsletter, and app popups before recording. |
| `scroll_back` | boolean | No | Scroll back to the top before the video ends. |
| `scroll_speed` | integer | No | Optional scrolling speed in CSS pixels per second. When omitted, Shotlane fits the full-page scroll into duration. |
| `reduce_motion` | boolean | No | Finish CSS animations and transitions and pause videos before recording. |
| `scroll_easing` | string ("ease_in_out" | "linear" | "ease_in" | "ease_out") | No | Easing curve used by the scrolling scenario. |
| `wait_to_leave` | string | No | CSS selector to wait up to 15 seconds for until it disappears. |
| `block_requests` | string | No | URL pattern or up to 50 patterns with * wildcards to block. |
| `block_trackers` | boolean | No | Block analytics and tracking requests. |
| `fail_on_status` | boolean | No | Fail without charging when the target page responds with 4xx or 5xx. |
| `hide_selectors` | string | No | CSS selector or selectors for elements to hide before recording. |
| `reduced_motion` | boolean | No | Record as a visitor who prefers reduced motion. The video-specific default is false so page animations play. |
| `block_resources` | string | No | Resource type or resource types to block while loading the page. |
| `viewport_mobile` | boolean | No | Override whether the browser uses mobile emulation. |
| `scroll_into_view` | string | No | CSS selector whose first matching element should be scrolled into view. |
| `wait_for_selector` | string | No | CSS selector or up to 20 selectors to await before recording. |
| `scripts_wait_until` | string | No | Load state or states to await if injected JavaScript navigates. |
| `scroll_start_delay` | integer | No | Milliseconds to show the top of the page before scrolling starts. |
| `viewport_has_touch` | boolean | No | Override whether the browser exposes touch input. |
| `viewport_landscape` | boolean | No | Turn the selected device preset sideways. |
| `hide_cookie_banners` | boolean | No | Hide cookie-consent dialogs before recording. |
| `fail_if_request_failed` | string | No | URL pattern or up to 50 patterns whose failed requests make the recording fail. |
| `fail_if_content_missing` | string | No | String or up to 20 strings whose absence makes the recording fail uncharged. |
| `fail_if_content_contains` | string | No | String or up to 20 strings whose presence makes the recording fail uncharged. |
| `wait_for_selector_algorithm` | string ("at_least_one" | "at_least_by_count") | No | For multiple wait selectors, continue after any one or after all are visible. |
| `error_on_click_selector_not_found` | boolean | No | Fail when the click selector has no clickable match. |
| `error_on_hover_selector_not_found` | boolean | No | Fail when the hover selector has no match. |

#### 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 |

### Check Monitor Now

**Slug:** `SHOTLANE_CHECK_MONITOR`

Run a monitor check immediately for one credit, replacing its next scheduled check, and return the comparison result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor id returned by create or list, beginning with mon_. |

#### 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 |

### Check Page on Multiple Devices

**Slug:** `SHOTLANE_CHECK_PAGE_ON_DEVICES`

Render one page or HTML document on one to eight devices and return hosted screenshots with layout, JavaScript, network, and accessibility diagnostics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run in the page before checking. |
| `css` | string | No | CSS to inject into the rendered page before checking. |
| `url` | string | No | Public page URL to check; provide exactly one of url or html. |
| `html` | string | No | Inline HTML to check; provide exactly one of url or html. |
| `click` | string | No | CSS selector to click before checking a state such as an open menu. |
| `delay` | integer | No | Extra milliseconds to wait after page load before checking. |
| `devices` | array | No | One to eight Shotlane preset or device-catalog ids. |
| `block_ads` | boolean | No | Block advertising and tracker requests while rendering. |
| `dark_mode` | string ("light" | "dark" | "both") | No | Theme to check: light, dark, or both. Both themes support at most four devices. |
| `full_page` | boolean | No | Scroll and check the page top to bottom instead of only the captured viewport. |
| `keep_days` | integer | No | Number of days to keep the hosted screenshot links. |
| `hide_popups` | boolean | No | Attempt to close or hide sign-in, newsletter, and app popups. |
| `wait_for_selector` | string | No | CSS selector or comma-separated selectors to await before checking. |
| `hide_cookie_banners` | boolean | No | Attempt to hide cookie-consent banners before checking. |

#### 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 Bulk Job

**Slug:** `SHOTLANE_CREATE_BULK_JOB`

Start a background job that renders up to 500 URLs into one ZIP archive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `mode` | string ("png" | "jpeg" | "pdf" | "markdown") | No | Output generated for every URL. |
| `urls` | string | No | One to 500 URLs, as an array or one URL per line. |
| `options` | object | No | Documented per-render options accepted by Shotlane bulk jobs. |
| `requests` | array | No | One to 500 URLs with per-URL render options. |
| `webhook_url` | string | No | Public HTTPS URL receiving a signed bulk.finished event. |
| `external_identifier` | string | No | Caller-defined ID echoed on the job and 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 |

### Create Monitor

**Slug:** `SHOTLANE_CREATE_MONITOR`

Create a recurring screenshot or Markdown change monitor for a URL; creation performs an initial credit-consuming check.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public page URL to monitor for changes. |
| `kind` | string ("screenshot" | "markdown") | No | Whether to detect visual screenshot changes or Markdown content changes. |
| `width` | integer | No | Viewport width in CSS pixels, from 240 through 1920. |
| `height` | integer | No | Viewport height in CSS pixels, from 240 through 2160. |
| `interval` | string ("hourly" | "6h" | "daily" | "weekly") | No | How often Shotlane should check the URL. |
| `selector` | string | No | CSS selector that restricts monitoring to the first matching element. |
| `block_ads` | boolean | No | Block advertising requests and hide their containers before comparison. |
| `full_page` | boolean | No | For screenshot monitors, compare the full scrollable page. |
| `threshold` | number | No | Percentage of changed pixels required before a screenshot monitor records a change, from 0 to 100. Shotlane's default is 1%. |
| `hide_popups` | boolean | No | Close or hide sign-in, newsletter, and app popups before comparison. |
| `webhook_url` | string | No | Public HTTPS endpoint to notify when the monitor detects a change. |
| `notify_email` | boolean | No | Send account-email notifications when a change is detected. |
| `wait_for_selector` | string | No | CSS selector to await before each monitor check. |
| `hide_cookie_banners` | boolean | No | Hide cookie-consent banners before comparison. |

#### 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 Multi-Device Screenshots

**Slug:** `SHOTLANE_CREATE_MULTI_DEVICE_SCREENSHOTS`

Capture one page or HTML document on one to eight devices and return expiring hosted image links, with optional per-device diagnostics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run in the page before capture. |
| `css` | string | No | CSS to inject into the rendered page before capture. |
| `url` | string | No | Public page URL to capture; provide exactly one of url or html. |
| `html` | string | No | Inline HTML to capture; provide exactly one of url or html. |
| `click` | string | No | CSS selector whose first matching element should be clicked before capture. |
| `delay` | integer | No | Extra milliseconds to wait after page load before capture. |
| `format` | string ("png" | "jpeg" | "webp" | "avif" | "gif" | "tiff" | "jp2" | "heif") | No | Image format for every screenshot. |
| `devices` | array | No | One to eight Shotlane preset or device-catalog ids. |
| `quality` | integer | No | Output quality for JPEG, WebP, or AVIF images. |
| `block_ads` | boolean | No | Block advertising and tracker requests while rendering. |
| `full_page` | boolean | No | Capture the full scrollable page on every device. |
| `keep_days` | integer | No | Number of days to keep the hosted screenshot links. |
| `diagnostics` | boolean | No | Add per-device layout, JavaScript, and network diagnostics and issue sentences. |
| `hide_popups` | boolean | No | Attempt to close or hide sign-in, newsletter, and app popups. |
| `wait_for_selector` | string | No | CSS selector or comma-separated selectors to await before capture. |
| `hide_cookie_banners` | boolean | No | Attempt to hide cookie-consent banners before 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 |

### Create PDF

**Slug:** `SHOTLANE_CREATE_PDF`

Render a URL, HTML document, or Markdown document as a PDF and return expiring hosted-link metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run in the page before PDF generation. |
| `css` | string | No | CSS to inject into the rendered page. |
| `url` | string | No | Public page URL to render; provide exactly one of url, html, or markdown. |
| `html` | string | No | Raw HTML document to render; provide exactly one of url, html, or markdown. |
| `delay` | integer | No | Extra milliseconds to wait after page load before rendering. |
| `paper` | string ("A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | "Letter" | "Legal" | "Tabloid" | "Ledger") | No | Standard PDF paper size. |
| `margin` | string | No | Margin on every side as a CSS length, such as 1cm. Omit to use Shotlane's default of 0 on all four sides. |
| `markdown` | string | No | Markdown document to render with Shotlane styling; provide exactly one of url, html, or markdown. |
| `selector` | string | No | CSS selector whose first matching element should be rendered. |
| `cache_ttl` | integer | No | Seconds to cache an identical render; cache hits do not consume credits. |
| `dark_mode` | boolean | No | Emulate a visitor who prefers a dark color scheme. |
| `landscape` | boolean | No | Use landscape rather than portrait orientation. |
| `watermark` | string | No | Diagonal watermark text to place on every page. |
| `hide_popups` | boolean | No | Attempt to close or hide sign-in, newsletter, and app popups. |
| `page_ranges` | string | No | Pages to keep, such as 1-3, 5. |
| `page_numbers` | boolean | No | Add a page-number footer in the form 1 / N. |
| `footer_template` | string | No | HTML footer template for each PDF page. |
| `header_template` | string | No | HTML header template for each PDF page. |
| `print_background` | boolean | No | Include CSS backgrounds in the PDF. |
| `wait_for_selector` | string | No | CSS selector or comma-separated selectors to await before rendering. |
| `external_identifier` | string | No | Caller-defined id echoed in the JSON result for correlation. |
| `hide_cookie_banners` | boolean | No | Attempt to hide cookie-consent banners before rendering. |

#### 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 Screenshot

**Slug:** `SHOTLANE_CREATE_SCREENSHOT`

Render a URL, HTML document, or Markdown document as an image and return a hosted result link that expires after the reported lifetime.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run in the page before capture. |
| `css` | string | No | CSS to inject into the rendered page before capture. |
| `url` | string | No | Public page URL to render; provide exactly one of url, html, or markdown. |
| `html` | string | No | Raw HTML document to render; provide exactly one of url, html, or markdown. |
| `click` | string | No | CSS selector whose first matching element should be clicked before capture. |
| `delay` | integer | No | Extra milliseconds to wait after page load before capture. |
| `width` | integer | No | Viewport width in CSS pixels. |
| `device` | string | No | Shotlane device preset id, such as desktop, ipad, iphone, pixel, or galaxy. |
| `format` | string ("png" | "jpeg" | "webp" | "avif" | "gif" | "tiff" | "jp2" | "heif" | "pdf" | "mhtml" | "html") | No | Output format: an image type, PDF, rendered HTML, or MHTML web archive. |
| `height` | integer | No | Viewport height in CSS pixels. |
| `quality` | integer | No | Output quality for JPEG, WebP, or AVIF images. |
| `markdown` | string | No | Markdown document to render with Shotlane styling; provide exactly one of url, html, or markdown. |
| `selector` | string | No | CSS selector whose first matching element should be captured. |
| `block_ads` | boolean | No | Block advertising and tracker requests while rendering. |
| `cache_ttl` | integer | No | Seconds to cache an identical render; cache hits do not consume credits. |
| `dark_mode` | boolean | No | Emulate a visitor who prefers a dark color scheme. |
| `full_page` | boolean | No | Capture the full scrollable page instead of only the viewport. |
| `hide_popups` | boolean | No | Attempt to close or hide sign-in, newsletter, and app popups. |
| `wait_for_selector` | string | No | CSS selector or comma-separated selectors to await before capture. |
| `external_identifier` | string | No | Caller-defined id echoed in the JSON result for correlation. |
| `hide_cookie_banners` | boolean | No | Attempt to hide cookie-consent banners before 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 |

### Delete Monitor

**Slug:** `SHOTLANE_DELETE_MONITOR`

Permanently delete a change monitor by id and stop its future scheduled checks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor id returned by create or list, beginning with mon_. |

#### 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 |

### Download Bulk Job ZIP

**Slug:** `SHOTLANE_DOWNLOAD_BULK_JOB_ZIP`

Download a finished bulk job's rendered files and results manifest as a ZIP. This action accepts at most 500 MB per download as a bounded-response safety cap; Shotlane documents no ZIP size limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Finished bulk job ID. |

#### 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 |

### Download Crawl ZIP

**Slug:** `SHOTLANE_DOWNLOAD_CRAWL_ZIP`

Download a finished crawl as a ZIP containing each page's Markdown and the crawl results index. This action accepts at most 100 MB per download as a bounded-response safety cap; Shotlane documents no ZIP size limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `crawl_id` | string | Yes | Finished crawl job id returned when the crawl was started. |

#### 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 Markdown

**Slug:** `SHOTLANE_EXTRACT_MARKDOWN`

Render a URL or HTML document, extract its main content as Markdown, and return structured JSON with optional links, images, HTML, and plain text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public page URL to extract; provide exactly one of url or html. |
| `html` | string | No | Raw HTML document to extract; provide exactly one of url or html. |
| `click` | string | No | CSS selector whose first matching element should be clicked before extraction. |
| `delay` | integer | No | Extra milliseconds to wait after page load before extraction. |
| `selector` | string | No | Restrict extraction to the first element matching this CSS selector. |
| `cache_ttl` | integer | No | Seconds to cache an identical extraction; cache hits do not consume credits. |
| `link_list` | boolean | No | Also return a structured list of extracted link URLs and text. |
| `max_chars` | integer | No | Maximum number of Markdown characters to return. |
| `hide_popups` | boolean | No | Attempt to close or hide sign-in, newsletter, and app popups. |
| `include_html` | boolean | No | Also return the rendered HTML in the JSON response. |
| `include_text` | boolean | No | Also return plain text in the JSON response. |
| `main_content` | boolean | No | Keep the primary article or page content and remove surrounding navigation and chrome. |
| `include_links` | boolean | No | Keep links in the generated Markdown and make them absolute. |
| `include_images` | boolean | No | Keep images in the generated Markdown as image links. |
| `exclude_selectors` | string | No | Comma-separated CSS selectors to remove before Markdown conversion. |
| `wait_for_selector` | string | No | CSS selector or comma-separated selectors to await before extraction. |
| `external_identifier` | string | No | Caller-defined id echoed in the JSON result for correlation. |
| `hide_cookie_banners` | boolean | No | Attempt to hide cookie-consent banners before extraction. |

#### 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 Account

**Slug:** `SHOTLANE_GET_ACCOUNT`

Return the connected Shotlane account's credit balances, email-confirmation state, and public key without exposing the account email.

#### 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 Bulk Job

**Slug:** `SHOTLANE_GET_BULK_JOB`

Retrieve a bulk job's progress and its per-URL results once finished.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | Bulk job ID returned when the job was created. |

#### 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 Crawl

**Slug:** `SHOTLANE_GET_CRAWL`

Retrieve a crawl job's progress and, after it finishes, its per-page results and ZIP download URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `crawl_id` | string | Yes | Crawl job id returned when the crawl was started. |

#### 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 Extracted Page Content

**Slug:** `SHOTLANE_GET_EXTRACT`

Render a URL, HTML, or Markdown source through Shotlane's GET extract endpoint and return structured JSON containing Markdown and page metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run before capture. |
| `css` | string | No | CSS to inject. |
| `url` | string | No | Page URL to render; HTTPS is assumed when omitted. Provide exactly one source. |
| `html` | string | No | Raw HTML to render instead of a URL; provide exactly one source. |
| `cache` | boolean | No | Cache for four hours unless cache_ttl is set. |
| `click` | string | No | CSS selector to click before capture. |
| `delay` | integer | No | Extra wait after load in milliseconds. |
| `hover` | string | No | CSS selector to hover before capture. |
| `scale` | number | No | Device scale factor. |
| `width` | integer | No | Viewport width. |
| `device` | string | No | Shotlane device preset id. |
| `height` | integer | No | Viewport height. |
| `locale` | string | No | Browser locale and Accept-Language value. |
| `timeout` | integer | No | Navigation timeout in seconds. |
| `latitude` | number | No | Geolocation latitude; use with longitude. |
| `markdown` | string | No | Markdown to render as a styled document; provide exactly one source. |
| `selector` | string | No | Capture only the first element matching this CSS selector. |
| `timezone` | string | No | IANA browser time zone. |
| `block_ads` | boolean | No | Block ad and tracker requests. |
| `cache_key` | string | No | Value mixed into the cache key. |
| `cache_ttl` | integer | No | Cache lifetime in seconds. |
| `dark_mode` | boolean | No | Emulate prefers-color-scheme: dark. |
| `full_page` | boolean | No | Capture the full scrollable page. |
| `link_list` | boolean | No | Include structured extracted links. |
| `longitude` | number | No | Geolocation longitude; use with latitude. |
| `max_chars` | integer | No | Maximum Markdown characters to return. |
| `bypass_csp` | boolean | No | Ignore the page Content-Security-Policy. |
| `disable_js` | boolean | No | Render without JavaScript. |
| `media_type` | string ("screen" | "print") | No | CSS media type. |
| `wait_until` | array | No | One or more navigation load states to await in order. |
| `block_chats` | boolean | No | Block chat widgets. |
| `hide_popups` | boolean | No | Close or hide sign-in, newsletter, and app modals. |
| `include_html` | boolean | No | Include rendered HTML. |
| `include_text` | boolean | No | Include extracted plain text. |
| `main_content` | boolean | No | Keep only the primary page content. |
| `include_links` | boolean | No | Keep links and make them absolute. |
| `reduce_motion` | boolean | No | Finish CSS animations and pause videos. |
| `wait_to_leave` | string | No | CSS selector that must disappear before capture. |
| `block_requests` | string | No | Comma-separated URL patterns to block; * is a wildcard. |
| `block_trackers` | boolean | No | Block analytics and tracking requests. |
| `fail_on_status` | boolean | No | Fail without charging when the target returns 4xx or 5xx. |
| `hide_selectors` | string | No | Comma-separated CSS selectors to hide. |
| `include_images` | boolean | No | Keep images as Markdown image links. |
| `reduced_motion` | boolean | No | Emulate prefers-reduced-motion: reduce. |
| `attachment_name` | string | No | Download filename for Content-Disposition. |
| `block_resources` | string | No | Comma-separated browser resource types to block. |
| `viewport_mobile` | boolean | No | Enable mobile viewport emulation. |
| `scroll_into_view` | string | No | CSS selector to scroll into view before capture. |
| `exclude_selectors` | string | No | Comma-separated selectors removed before conversion. |
| `wait_for_selector` | string | No | Comma-separated selectors to wait for. |
| `scripts_wait_until` | string ("load" | "domcontentloaded" | "networkidle") | No | Load state to await after injected JavaScript navigates. |
| `viewport_has_touch` | boolean | No | Enable touch events in the viewport. |
| `viewport_landscape` | boolean | No | Swap the device preset width and height. |
| `external_identifier` | string | No | Caller-defined id echoed in JSON responses. |
| `hide_cookie_banners` | boolean | No | Hide cookie consent banners. |
| `fail_if_request_failed` | string | No | Request URL patterns whose failure should fail the render. |
| `fail_if_content_missing` | string | No | Fail when page text lacks this value. |
| `fail_if_content_contains` | string | No | Fail when page text contains this value. |
| `wait_for_selector_algorithm` | string ("at_least_one" | "at_least_by_count") | No | Whether any or all selectors must appear. |
| `error_on_click_selector_not_found` | boolean | No | Fail when the click selector matches nothing. |
| `error_on_hover_selector_not_found` | boolean | No | Fail when the hover selector matches nothing. |

#### 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 Site Map

**Slug:** `SHOTLANE_GET_MAP`

Call Shotlane's GET map endpoint to list same-site URLs discovered from one rendered page and its sitemaps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Page whose same-site links and sitemaps should be mapped. |
| `limit` | integer | No | Maximum URLs to return. |
| `search` | string | No | Substring used to filter returned URLs. |
| `sitemap` | boolean | No | Include URLs discovered from sitemaps. |
| `include_subdomains` | boolean | No | Include URLs on subdomains. |

#### 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 Page as Markdown

**Slug:** `SHOTLANE_GET_MARKDOWN`

Render a public page, PDF, or inline HTML and return its main content as clean Markdown. Use the POST variant for large inline HTML.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public page or PDF URL to convert; provide exactly one of url or html. |
| `html` | string | No | Inline HTML to convert; provide exactly one of url or html. Prefer POST for large HTML. |
| `click` | string | No | CSS selector whose first matching element should be clicked before conversion. |
| `delay` | integer | No | Extra milliseconds to wait after page load before conversion. |
| `selector` | string | No | Convert only the first element matching this CSS selector. |
| `cache_ttl` | integer | No | Seconds to cache an identical conversion; cache hits do not consume credits. |
| `max_chars` | integer | No | Maximum number of Markdown characters to return. |
| `hide_popups` | boolean | No | Attempt to close or hide sign-in, newsletter, and app popups. |
| `main_content` | boolean | No | Keep only the main content instead of converting the whole page. |
| `include_links` | boolean | No | Keep links in the Markdown and make them absolute. |
| `include_images` | boolean | No | Keep images as Markdown image links. |
| `exclude_selectors` | string | No | Comma-separated CSS selectors to remove before conversion. |
| `wait_for_selector` | string | No | CSS selector or comma-separated selectors to await before conversion. |
| `hide_cookie_banners` | boolean | No | Attempt to hide cookie-consent banners before conversion. |

#### 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 Monitor

**Slug:** `SHOTLANE_GET_MONITOR`

Return one change monitor and its recent checks by monitor id.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `monitor_id` | string | Yes | Monitor id returned by create or list, beginning with mon_. |

#### 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 PDF

**Slug:** `SHOTLANE_GET_PDF`

Render a URL, HTML, or Markdown source through Shotlane's GET PDF endpoint and return JSON metadata with a hosted 24-hour PDF link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run before capture. |
| `css` | string | No | CSS to inject. |
| `url` | string | No | Page URL to render; HTTPS is assumed when omitted. Provide exactly one source. |
| `html` | string | No | Raw HTML to render instead of a URL; provide exactly one source. |
| `cache` | boolean | No | Cache for four hours unless cache_ttl is set. |
| `click` | string | No | CSS selector to click before capture. |
| `delay` | integer | No | Extra wait after load in milliseconds. |
| `hover` | string | No | CSS selector to hover before capture. |
| `paper` | string ("A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | "Letter" | "Legal" | "Tabloid" | "Ledger") | No | Standard PDF paper size. |
| `scale` | number | No | Device scale factor. |
| `width` | integer | No | Viewport width. |
| `device` | string | No | Shotlane device preset id. |
| `height` | integer | No | Viewport height. |
| `locale` | string | No | Browser locale and Accept-Language value. |
| `margin` | string | No | All margins as a CSS length, such as 1cm; when omitted, Shotlane's default is 0 on all four sides. |
| `quality` | integer | No | JPEG or WebP quality for page resources. |
| `timeout` | integer | No | Navigation timeout in seconds. |
| `latitude` | number | No | Geolocation latitude; use with longitude. |
| `markdown` | string | No | Markdown to render as a styled document; provide exactly one source. |
| `selector` | string | No | Capture only the first element matching this CSS selector. |
| `timezone` | string | No | IANA browser time zone. |
| `block_ads` | boolean | No | Block ad and tracker requests. |
| `cache_key` | string | No | Value mixed into the cache key. |
| `cache_ttl` | integer | No | Cache lifetime in seconds. |
| `dark_mode` | boolean | No | Emulate prefers-color-scheme: dark. |
| `full_page` | boolean | No | Capture the full scrollable page. |
| `landscape` | boolean | No | Use landscape orientation. |
| `longitude` | number | No | Geolocation longitude; use with latitude. |
| `pdf_scale` | number | No | PDF content scale. |
| `pdf_title` | string | No | PDF document title metadata. |
| `pdf_width` | string | No | Custom page width, such as 100mm. |
| `watermark` | string | No | Diagonal watermark text on every page. |
| `bypass_csp` | boolean | No | Ignore the page Content-Security-Policy. |
| `disable_js` | boolean | No | Render without JavaScript. |
| `media_type` | string ("screen" | "print") | No | CSS media type. |
| `pdf_author` | string | No | PDF document author metadata. |
| `pdf_height` | string | No | Custom page height; use with pdf_width. |
| `wait_until` | array | No | One or more navigation load states to await in order. |
| `block_chats` | boolean | No | Block chat widgets. |
| `hide_popups` | boolean | No | Close or hide sign-in, newsletter, and app modals. |
| `page_ranges` | string | No | Pages to keep, such as 1-3, 5. |
| `pdf_subject` | string | No | PDF document subject metadata. |
| `page_numbers` | boolean | No | Add a 1 / N footer. |
| `pdf_keywords` | string | No | PDF document keyword metadata. |
| `reduce_motion` | boolean | No | Finish CSS animations and pause videos. |
| `wait_to_leave` | string | No | CSS selector that must disappear before capture. |
| `block_requests` | string | No | Comma-separated URL patterns to block; * is a wildcard. |
| `block_trackers` | boolean | No | Block analytics and tracking requests. |
| `fail_on_status` | boolean | No | Fail without charging when the target returns 4xx or 5xx. |
| `hide_selectors` | string | No | Comma-separated CSS selectors to hide. |
| `reduced_motion` | boolean | No | Emulate prefers-reduced-motion: reduce. |
| `attachment_name` | string | No | Download filename for Content-Disposition. |
| `block_resources` | string | No | Comma-separated browser resource types to block. |
| `footer_template` | string | No | Footer HTML for each page. |
| `header_template` | string | No | Header HTML for each page. |
| `viewport_mobile` | boolean | No | Enable mobile viewport emulation. |
| `pdf_fit_one_page` | boolean | No | Fit the whole document on one page. |
| `print_background` | boolean | No | Include CSS backgrounds. |
| `scroll_into_view` | string | No | CSS selector to scroll into view before capture. |
| `wait_for_selector` | string | No | Comma-separated selectors to wait for. |
| `watermark_opacity` | number | No | Watermark opacity. |
| `scripts_wait_until` | string ("load" | "domcontentloaded" | "networkidle") | No | Load state to await after injected JavaScript navigates. |
| `viewport_has_touch` | boolean | No | Enable touch events in the viewport. |
| `viewport_landscape` | boolean | No | Swap the device preset width and height. |
| `external_identifier` | string | No | Caller-defined id echoed in JSON responses. |
| `hide_cookie_banners` | boolean | No | Hide cookie consent banners. |
| `fail_if_request_failed` | string | No | Request URL patterns whose failure should fail the render. |
| `fail_if_content_missing` | string | No | Fail when page text lacks this value. |
| `fail_if_content_contains` | string | No | Fail when page text contains this value. |
| `wait_for_selector_algorithm` | string ("at_least_one" | "at_least_by_count") | No | Whether any or all selectors must appear. |
| `error_on_click_selector_not_found` | boolean | No | Fail when the click selector matches nothing. |
| `error_on_hover_selector_not_found` | boolean | No | Fail when the hover selector matches nothing. |

#### 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 Async Render

**Slug:** `SHOTLANE_GET_RENDER`

Retrieve the status and eventual hosted or stored result of an asynchronous screenshot, PDF, Markdown, or extraction render.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `render_id` | string | Yes | Async render id returned by a render request made with async=true. |

#### 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

**Slug:** `SHOTLANE_GET_SCREENSHOT`

Render a URL, HTML, or Markdown source through Shotlane's GET screenshot endpoint and return JSON metadata with a hosted 24-hour result link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run before capture. |
| `css` | string | No | CSS to inject. |
| `url` | string | No | Page URL to render; HTTPS is assumed when omitted. Provide exactly one source. |
| `html` | string | No | Raw HTML to render instead of a URL; provide exactly one source. |
| `cache` | boolean | No | Cache for four hours unless cache_ttl is set. |
| `click` | string | No | CSS selector to click before capture. |
| `delay` | integer | No | Extra wait after load in milliseconds. |
| `hover` | string | No | CSS selector to hover before capture. |
| `scale` | number | No | Device scale factor. |
| `width` | integer | No | Viewport width. |
| `clip_x` | integer | No | Clip region x coordinate. |
| `clip_y` | integer | No | Clip region y coordinate. |
| `device` | string | No | Shotlane device preset id. |
| `format` | string ("png" | "jpeg" | "webp" | "avif" | "gif" | "tiff" | "jp2" | "heif" | "pdf" | "mhtml" | "html") | No | Rendered output format. |
| `height` | integer | No | Viewport height. |
| `locale` | string | No | Browser locale and Accept-Language value. |
| `quality` | integer | No | JPEG, WebP, or AVIF quality. |
| `timeout` | integer | No | Navigation timeout in seconds. |
| `latitude` | number | No | Geolocation latitude; use with longitude. |
| `markdown` | string | No | Markdown to render as a styled document; provide exactly one source. |
| `selector` | string | No | Capture only the first element matching this CSS selector. |
| `timezone` | string | No | IANA browser time zone. |
| `block_ads` | boolean | No | Block ad and tracker requests. |
| `cache_key` | string | No | Value mixed into the cache key. |
| `cache_ttl` | integer | No | Cache lifetime in seconds. |
| `dark_mode` | boolean | No | Emulate prefers-color-scheme: dark. |
| `full_page` | boolean | No | Capture the full scrollable page. |
| `image_fit` | string ("cover" | "contain" | "fill") | No | Fit mode when both image sizes are set. |
| `longitude` | number | No | Geolocation longitude; use with latitude. |
| `bypass_csp` | boolean | No | Ignore the page Content-Security-Policy. |
| `clip_width` | integer | No | Clip region width. |
| `disable_js` | boolean | No | Render without JavaScript. |
| `media_type` | string ("screen" | "print") | No | CSS media type. |
| `wait_until` | array | No | One or more navigation load states to await in order. |
| `block_chats` | boolean | No | Block chat widgets. |
| `clip_height` | integer | No | Clip region height. |
| `hide_popups` | boolean | No | Close or hide sign-in, newsletter, and app modals. |
| `image_width` | integer | No | Resize output width. |
| `image_height` | integer | No | Resize output height. |
| `reduce_motion` | boolean | No | Finish CSS animations and pause videos. |
| `wait_to_leave` | string | No | CSS selector that must disappear before capture. |
| `block_requests` | string | No | Comma-separated URL patterns to block; * is a wildcard. |
| `block_trackers` | boolean | No | Block analytics and tracking requests. |
| `fail_on_status` | boolean | No | Fail without charging when the target returns 4xx or 5xx. |
| `hide_selectors` | string | No | Comma-separated CSS selectors to hide. |
| `reduced_motion` | boolean | No | Emulate prefers-reduced-motion: reduce. |
| `attachment_name` | string | No | Download filename for Content-Disposition. |
| `block_resources` | string | No | Comma-separated browser resource types to block. |
| `viewport_mobile` | boolean | No | Enable mobile viewport emulation. |
| `full_page_scroll` | boolean | No | Scroll first so lazy full-page content loads. |
| `full_page_slices` | boolean | No | Return JSON with one hosted link per full-page slice. |
| `scroll_into_view` | string | No | CSS selector to scroll into view before capture. |
| `wait_for_selector` | string | No | Comma-separated selectors to wait for. |
| `scripts_wait_until` | string ("load" | "domcontentloaded" | "networkidle") | No | Load state to await after injected JavaScript navigates. |
| `viewport_has_touch` | boolean | No | Enable touch events in the viewport. |
| `viewport_landscape` | boolean | No | Swap the device preset width and height. |
| `external_identifier` | string | No | Caller-defined id echoed in JSON responses. |
| `full_page_scroll_by` | integer | No | Pixels per full-page scroll step. |
| `hide_cookie_banners` | boolean | No | Hide cookie consent banners. |
| `full_page_max_height` | integer | No | Maximum full-page capture height in CSS pixels, up to 100,000. |
| `fail_if_request_failed` | string | No | Request URL patterns whose failure should fail the render. |
| `full_page_scroll_delay` | integer | No | Milliseconds between full-page scroll steps. |
| `full_page_slice_height` | integer | No | Slice height in CSS pixels. |
| `fail_if_content_missing` | string | No | Fail when page text lacks this value. |
| `fail_if_content_contains` | string | No | Fail when page text contains this value. |
| `error_on_selector_not_found` | boolean | No | Fail when selector matches nothing. |
| `wait_for_selector_algorithm` | string ("at_least_one" | "at_least_by_count") | No | Whether any or all selectors must appear. |
| `full_page_slice_overlap_height` | integer | No | Overlap between slices in CSS pixels. |
| `error_on_click_selector_not_found` | boolean | No | Fail when the click selector matches nothing. |
| `error_on_hover_selector_not_found` | boolean | No | Fail when the hover selector matches nothing. |

#### 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 Site Report

**Slug:** `SHOTLANE_GET_SITE_REPORT`

Analyze one public page for AI-crawler access, llms.txt, server-rendered content, link-preview metadata, structured data, and actionable fixes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Public page URL to analyze for AI readiness and link previews. |

#### 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:** `SHOTLANE_GET_USAGE`

Return current Shotlane credits, recent usage, plan tier, rate-limit budget, and render concurrency availability.

#### 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 Bulk Jobs

**Slug:** `SHOTLANE_LIST_BULK_JOBS`

List the connected account's ten most recent bulk and crawl jobs.

#### 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 Devices

**Slug:** `SHOTLANE_LIST_DEVICES`

List every Shotlane device preset with its viewport, pixel ratio, mobile and touch behavior, and user agent.

#### 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 Monitors

**Slug:** `SHOTLANE_LIST_MONITORS`

List all change monitors on the connected Shotlane account.

#### 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 |

### Map Site

**Slug:** `SHOTLANE_MAP_SITE`

Render one page and list same-site URLs discovered from its links and sitemaps, optionally filtering the results by a URL substring.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Any page on the site whose links and sitemaps should be mapped. |
| `limit` | integer | No | Maximum number of URLs to return. |
| `search` | string | No | Case-insensitive substring used to keep only matching URLs. |
| `sitemap` | boolean | No | Include URLs discovered from the site's robots.txt and sitemaps. |
| `include_subdomains` | boolean | No | Keep URLs on subdomains of the supplied site's host. |

#### 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 |

### Convert HTML or Page to Markdown

**Slug:** `SHOTLANE_POST_MARKDOWN`

Render a public page, PDF, or inline HTML supplied in JSON and return its main content as clean Markdown.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Public page or PDF URL to convert; provide exactly one of url or html. |
| `html` | string | No | Inline HTML to convert; provide exactly one of url or html. |
| `click` | string | No | CSS selector whose first matching element should be clicked before conversion. |
| `delay` | integer | No | Extra milliseconds to wait after page load before conversion. |
| `selector` | string | No | Convert only the first element matching this CSS selector. |
| `cache_ttl` | integer | No | Seconds to cache an identical conversion; cache hits do not consume credits. |
| `max_chars` | integer | No | Maximum number of Markdown characters to return. |
| `hide_popups` | boolean | No | Attempt to close or hide sign-in, newsletter, and app popups. |
| `main_content` | boolean | No | Keep only the main content instead of converting the whole page. |
| `include_links` | boolean | No | Keep links in the Markdown and make them absolute. |
| `include_images` | boolean | No | Keep images as Markdown image links. |
| `exclude_selectors` | string | No | Comma-separated CSS selectors to remove before conversion. |
| `wait_for_selector` | string | No | CSS selector or comma-separated selectors to await before conversion. |
| `hide_cookie_banners` | boolean | No | Attempt to hide cookie-consent banners before conversion. |

#### 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 |

### Scrape Page Elements

**Slug:** `SHOTLANE_SCRAPE_ELEMENTS`

Render a URL or inline HTML and extract named values with CSS selectors. Returns the first match as a scalar or up to 1,000 matches as a list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `js` | string | No | JavaScript to run in the page; await is supported. |
| `css` | string | No | CSS to inject into the page. |
| `url` | string | No | Public page URL to render and scrape; provide exactly one of url or html. |
| `html` | string | No | Raw HTML to scrape; provide exactly one of url or html. |
| `cache` | boolean | No | Cache the scrape for four hours unless cache_ttl is set. |
| `click` | string | No | CSS selector whose first matching element should be clicked. |
| `delay` | integer | No | Extra milliseconds to wait before scraping. |
| `hover` | string | No | CSS selector whose first matching element should be hovered. |
| `scale` | number | No | Device pixels per CSS pixel. Omit to use the device preset or provider default of 1. |
| `width` | integer | No | Viewport width in CSS pixels. Omit to use the device preset or provider default of 1280. |
| `device` | string | No | Shotlane device preset id. |
| `height` | integer | No | Viewport height in CSS pixels. Omit to use the device preset or provider default of 800. |
| `locale` | string | No | Browser locale and Accept-Language value. |
| `timeout` | integer | No | Maximum page navigation time in seconds. |
| `accuracy` | number | No | Geolocation accuracy in meters. |
| `elements` | object | Yes | Named values to extract. Map each output name to a CSS selector string, or to an object with selector, attr, and all. At most 50 names are allowed. |
| `latitude` | number | No | Geolocation latitude; send with longitude. |
| `timezone` | string | No | IANA time zone exposed to the page. |
| `block_ads` | boolean | No | Block advertising requests and hide their containers. |
| `cache_key` | string | No | Value that separates otherwise identical cached requests. |
| `cache_ttl` | integer | No | Seconds to cache an identical scrape. Omit to let cache=true use its four-hour default. |
| `dark_mode` | boolean | No | Emulate a visitor who prefers a dark color scheme. |
| `longitude` | number | No | Geolocation longitude; send with latitude. |
| `bypass_csp` | boolean | No | Ignore the target page's Content-Security-Policy for injected JavaScript. |
| `disable_js` | boolean | No | Load and scrape the page with JavaScript disabled. |
| `media_type` | string ("screen" | "print") | No | CSS media type applied while rendering. |
| `user_agent` | string | No | User-Agent value exposed to the target page. |
| `wait_until` | string | No | One navigation load state or a sequence to await in order. |
| `block_chats` | boolean | No | Block chat widgets. |
| `hide_popups` | boolean | No | Close or hide sign-in, newsletter, and app popups. |
| `reduce_motion` | boolean | No | Finish animations and transitions and pause videos before scraping. |
| `wait_to_leave` | string | No | CSS selector to wait up to 15 seconds for until it disappears. |
| `block_requests` | string | No | URL pattern or up to 50 patterns with * wildcards to block. |
| `block_trackers` | boolean | No | Block analytics and tracking requests. |
| `fail_on_status` | boolean | No | Fail when the target page responds with 4xx or 5xx. |
| `hide_selectors` | string | No | CSS selector or selectors for elements to hide. |
| `reduced_motion` | boolean | No | Emulate a visitor whose prefers-reduced-motion setting is reduce. |
| `block_resources` | string | No | Browser resource type or types to block. |
| `viewport_mobile` | boolean | No | Override whether the browser uses mobile emulation. |
| `scroll_into_view` | string | No | CSS selector whose first match should be scrolled into view. |
| `wait_for_selector` | string | No | CSS selector or up to 20 selectors to await. |
| `scripts_wait_until` | string ("load" | "domcontentloaded" | "networkidle") | No | Load state to await if injected JavaScript navigates. |
| `viewport_has_touch` | boolean | No | Override whether the browser exposes touch input. |
| `viewport_landscape` | boolean | No | Turn the selected device preset sideways. |
| `hide_cookie_banners` | boolean | No | Hide cookie-consent dialogs before scraping. |
| `fail_if_request_failed` | string | No | URL pattern or up to 50 patterns whose failed requests make scraping fail. |
| `fail_if_content_missing` | string | No | String or up to 20 strings whose absence makes scraping fail. |
| `fail_if_content_contains` | string | No | String or up to 20 strings whose presence makes scraping fail. |
| `wait_for_selector_algorithm` | string ("at_least_one" | "at_least_by_count") | No | For multiple wait selectors, continue after any one or after all are visible. |
| `error_on_click_selector_not_found` | boolean | No | Fail when the click selector has no clickable match. |
| `error_on_hover_selector_not_found` | boolean | No | Fail when the hover selector has no match. |

#### 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 |

### Start Crawl

**Slug:** `SHOTLANE_START_CRAWL`

Start a breadth-first site crawl that asynchronously converts up to 500 matching pages to Markdown and packages them in a ZIP.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Page URL where the breadth-first site crawl should start. |
| `limit` | integer | No | Maximum number of pages to crawl. |
| `exclude` | array | No | URL substring or wildcard patterns that must never be followed. |
| `include` | array | No | URL substring or wildcard patterns that a URL must match to be followed. |
| `sitemap` | boolean | No | Whether to seed the crawl with URLs from the site's sitemaps. |
| `max_depth` | integer | No | Maximum link-hop depth from the start page. |
| `webhook_url` | string | No | Public HTTPS endpoint that receives a signed crawl.finished event. |
| `respect_robots` | boolean | No | Whether to skip pages disallowed by robots.txt. |
| `include_subdomains` | boolean | No | Whether to follow links on subdomains of the start URL's host. |

#### 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 Monitor

**Slug:** `SHOTLANE_UPDATE_MONITOR`

Pause or resume a monitor, change its interval, or update its email and webhook notifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Set true to resume scheduled checks or false to pause them. |
| `interval` | string ("hourly" | "6h" | "daily" | "weekly") | No | New recurring check interval. |
| `monitor_id` | string | Yes | Monitor id returned by create or list, beginning with mon_. |
| `webhook_url` | string | No | New public HTTPS change-notification endpoint. |
| `notify_email` | boolean | No | Whether to email the account when a change is detected. |

#### 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 |
