Web research

Capture an external page

Renders an external public page in a real browser and returns the image, to study a reference site or the user's existing site: its layout, hierarchy, density, and feel. Consent banners and overlays are dismissed first. Focus with selector (plus padding) or clip and page down with scrollTo; external pages render in their own color scheme and never full page. Capture your own website with websitePreview.capture. Charged in AI credits to the website's organization.

post/webResearch/screenshot

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/webResearch/screenshot
  • Auth: HTTP bearer

Request body

websiteIdstring required

A website you can edit; its organization pays for the call in AI credits.

urlstring uri required

Absolute public http(s) URL of the page to capture.

viewport'desktop' | 'tablet' | 'mobile'

Device class to render at.

selectorstring

Crop to the first element matching this CSS selector, scrolled into view. Preferred: it follows the layout at every viewport.

paddinginteger

CSS pixels of surrounding page to include on every side of the selector match.

waitForSelectorstring

Wait for this CSS selector to match before capturing.

delayMsinteger

Extra settle time before capturing, in milliseconds.

freezeAnimationsboolean

Fast-forward CSS animations and transitions to their end state so captures are deterministic.

Response

Rendered page image.

Changes

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