v37

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-03204242.8 KB

Screenshot / Styleguide

Take screenshot of website

Capture a screenshot of a website. Supports both viewport (standard browser view) and full-page screenshots. Can also screenshot specific page types (login, pricing, etc.) by using heuristics to find the appropriate URL. Returns a URL to the uploaded screenshot image hosted on our CDN.

get/brand/screenshot

Query parameters

domainstring required

Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domain will be automatically normalized and validated.

fullScreenshot'true' | 'false'

Optional parameter to determine screenshot type. If 'true', takes a full page screenshot capturing all content. If 'false' or not provided, takes a viewport screenshot (standard browser view).

Optional parameter to specify which page type to screenshot. If provided, the system will scrape the domain's links and use heuristics to find the most appropriate URL for the specified page type (30 supported languages). If not provided, screenshots the main domain landing page.

prioritize'speed' | 'quality'

Optional parameter to prioritize screenshot capture. If 'speed', optimizes for faster capture with basic quality. If 'quality', optimizes for higher quality with longer wait times. Defaults to 'quality' if not provided.

Response

Successful response

statusstring

Status of the response, e.g., 'ok'

domainstring

The normalized domain that was processed

screenshotstring

Public URL of the uploaded screenshot image

screenshotType'viewport' | 'fullPage'

Type of screenshot that was captured

codeinteger

HTTP status code