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.
Authorizations
Cactal API key. Create one in the dashboard or via POST /apiKeys. The plaintext key is shown once at creation.
Body
A website you can edit; its organization pays for the call in AI credits.
1Absolute public http(s) URL of the page to capture.
2048Device class to render at.
desktop, tablet, mobile Crop to the first element matching this CSS selector, scrolled into view. Preferred: it follows the layout at every viewport.
1CSS pixels of surrounding page to include on every side of the selector match.
0 <= x <= 500Crop to this rectangle, in CSS pixels from the top-left of the rendered page at the chosen viewport; it is scrolled into view and must fit within the viewport. Only for regions no selector frames.
Scroll to a CSS selector or an absolute Y offset before capturing.
1Wait for this CSS selector to match before capturing.
1Extra settle time before capturing, in milliseconds.
0 <= x <= 5000Fast-forward CSS animations and transitions to their end state so captures are deterministic.
Response
Rendered page image.
The response is of type file.