bestAttemptboolean
Если true (по умолчанию), захва тывает всё, что отрисовано на момент таймаута, вместо завершения с ошибкой. Установите false, чтобы при таймауте возникала жёсткая ошибка.
blockAdsboolean
Блокирует рекламу и трекеры перед захватом.
blockCookieBannersboolean
Скрывает распространённые баннеры cookie/согласия (баннеры GDPR/CCPA) перед захватом. Курируемый список селекторов, более лёгкий, чем кастомные hideSelectors.
blockResourceTypesenum[]
Блокирует определённые типы ресурсов для ускорения захвата. Например, ['font', 'image'] для скриншотов, содержащих только текст.
cookiesobject[]
Файлы cookie для установки перед захватом. Полезно для страниц с аутентификацией. Максимум 50 файлов cookie.
cssstring
Пользовательский CSS для внедрения в страницу перед захватом. Скрывает cookie-баннеры, добавляет водяные знаки, переопределяет стили. Максимум 50 КБ.
darkModeboolean
Эмулирует тёмную цветовую схему (prefers-color-scheme: dark)
dataobject
Объект данных в формате «ключ-значение» для шаблонов Mustache. Когда он указан, строка 'html' или 'markdown' перед захватом обрабатывается как беслогичный шаблон Mustache: {{var}} вставляет HTML-экранированное значение, {{{var}}} вставляет без экранирования, {{#items}}...{{/items}} перебирает массивы, {{a.b}} обращается к вложенным полям. Нельзя использовать вместе с 'url'. Максимум 256 КБ в сериализованном виде.
delayinteger
Миллисекунды ожидания после загрузки страницы перед захватом (полезно для контента, отрисованного с помощью JavaScript).
deviceenum
Пресет устройства, который задает viewport, scale factor и user agent за один раз. Например, 'iphone_15' для мобильного скриншота. Переопределяет width/height/deviceScaleFactor/userAgent.
deviceScaleFactornumber
Device pixel ratio (1 = стандартный, 2 = Retina). По умолчанию 2× Retina.
expiresIninteger
Секунды до истечения срока действия подписанного URL (60-2592000). По умолчанию используется TTL сервера.
formatenum
Формат вывода: png (без потерь), jpeg (меньше), webp (самый маленький) или pdf (документ). Используйте pdf для счетов, отчетов, архивирования.
fullPageboolean
Захватывает всю прокручиваемую страницу, а не только видимую область.
geostring
Код страны ISO 3166-1 alpha-2 для захвата с гео-таргетингом (например, 'US', 'DE', 'JP'). Отображает страницу так, как она видна из этой страны. Только для Pro/Enterprise. Примечание: CSS/JS-инъекции, cookies, захват элементов, тёмная тема и некоторые другие функции недоступны при гео-таргетинге.
geoCitystring
Город для более точного геотаргетинга (например, 'Berlin', 'New York'). Требует 'geo'.
geoStatestring
Штат или регион для более точного геотаргетинга (например, 'California'). Требует 'geo'.
headersobject
Настраиваемые HTTP-заголовки для отправки с запросом страницы. Нельзя переопределить Host, Connection, Content-Length или Transfer-Encoding.
heightinteger
Высота области просмотра в пикселях.
hideSelectorsstring[]
CSS-селекторы для скрытия (display:none) перед захватом. Например, ['.modal', '#newsletter-popup'], чтобы удалить оверлеи. Максимум 50 селекторов.
htmlstring
Сырой HTML для рендеринга и захвата. Несовместим с 'url' и 'markdown'. Отлично подходит для счетов, карточек для соцсетей, шаблонов писем и изображений OG.
jsstring
Выполняет пользовательский JavaScript на странице перед захватом. Работает в песочнице браузера. Максимум 50 КБ.
markdownstring
Markdown для рендеринга в изображение или PDF. Взаимоисключаем с 'url' и 'html'. Сервер преобразует его в HTML перед рендерингом. Отлично подходит для отчетов, примечаний к релизам, снимков README, карточек документации.
pdfFormatenum
Размер страницы PDF. Используется только при format='pdf'. По умолчанию: A4
pdfLandscapeboolean
Альбомная ориентация PDF. Используется только при format='pdf'.
pdfMarginobject
Поля страницы PDF. Используется только при format='pdf'. Принимает значения CSS.
pdfPrintBackgroundboolean
Печатать фоновые цвета и изображения в PDF. По умолчанию: true
pdfScalenumber
Коэффициент масштабирования PDF (0.1-2). По умолчанию: 1
qualityinteger
Качество изображения 1-100 (только JPEG/WebP, игнорируется для PNG/PDF)
resizeHeightinteger
Уменьшает захваченное изображение до указанной высоты в пикселях (16-2160). Соотношение сторон сохраняется, если параметр resizeWidth не указан. Для PDF игнорируется.
resizeWidthinteger
Уменьшает масштаб захваченного изображения до указанной ширины в пикселях (16-3840). Соотношение сторон сохраняется, если resizeHeight не указан. Игнорируется для PDF.
selectorstring
Определяет конкретный элемент по CSS-селектору для захвата вместо всей страницы. Полезен для OG-изображений и извлечения компонентов (например, '#hero', '.pricing-card').
timeoutinteger
Максимальное количество секунд ожидания загрузки страницы (5-60). У Cloudflare жёсткий лимит в 60 секунд.
urlstring
URL веб-страницы для захвата (принимается хост без схемы, например 'example.com'). Взаимоисключающ с 'html' и 'markdown'.
userAgentstring
Переопределяет строку user agent браузера.
waitForSelectorstring
CSS-селектор, ожидаемый перед захватом. Важен для одностраничных приложений (например, '.main-content', '#app-loaded').
waitUntilenum
Событие готовности страницы. networkidle2 (по умолчанию) лучше всего подходит для большинства сайтов. Используйте domcontentloaded для скорости, networkidle0 для полноты.
widthinteger
Ширина области просмотра в пикселях
