Create a scheduled capture

Capture a URL every hour, day or week. The first capture runs within a minute. Each capture counts as one render (failed renders are refunded), is stored as PNG with its SHA-256, and is compared with the previous capture. Subscribe to the capture.completed and change.detected webhook events to be notified. Every plan includes schedules: Free holds 1 (daily or weekly, kept 7 days), Starter 5 (14 days), Growth 25 (30 days), Business 100 (90 days), Scale 300 (180 days).

post/v1/schedules

Request

Base URL: https://app.snap-render.com
URL: https://app.snap-render.com/v1/schedules
Auth: API key in header X-API-Key

Request body

urlstring uri required

Page to capture. Public http or https URL.

interval'hourly' | 'daily' | 'weekly' required

namestring

format'png'

Captures are always PNG so they can be compared.

widthinteger

heightinteger

full_pageboolean

delayinteger

dark_modeboolean

block_adsboolean

block_cookie_bannersboolean

hide_selectorsstring

click_selectorstring

device'iphone_14' | 'iphone_15_pro' | 'pixel_7' | 'ipad_pro' | 'macbook_pro'

user_agentstring

change_thresholdnumber

Percent of the page that must change before change.detected fires.

notify_emailboolean

Email the account owner when change.detected fires: verified addresses only, at most one email per schedule every 50 minutes and 50 per account a day.

Response

Schedule created

idstring uuid

namestring nullable

urlstring uri

interval'hourly' | 'daily' | 'weekly'

format'png'

optionsobject

Render options, same names as the batch endpoint.

changeThresholdnumber

notifyEmailboolean

isActiveboolean

pausedReason'user' | 'plan' | 'failures' | 'account' | 'null' nullable

consecutiveFailuresinteger

lastErrorstring nullable

lastRunAtstring date-time nullable

nextRunAtstring date-time nullable

createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.