v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-2972102177.5 KB

Tools

Screenshot Webpage

This endpoint captures a screenshot of the specified webpage using Chromium. Users can customize the viewport dimensions and capture options.

post/v1/tools/screenshot

Query parameters

sessionIdstring

An optional browser session identifier to reference an existing running browser sessions. When passed, the tool will be executed on the provided browser session.

Request body

urlstring

The URL of the webpage to capture.

widthinteger

The width of the browser viewport in pixels.

heightinteger

The height of the browser viewport in pixels.

image_qualityinteger

Quality of the output image, on the range 1-100. 100 will not perform any compression.

waitinteger

Duration in milliseconds to wait after page has loaded, mainly used for sites with JS animations.

scroll_all_contentboolean

If true, scrolls the page and captures all visible content.

capture_full_heightboolean

If true, captures the entire height of the page, ignoring the viewport height.

s3_target_addressstring

Presigned S3 url target to upload the image to.

Response

Screenshot successfully captured.