API Reference
Screenshot webpage
API Reference
Screenshot webpage
This endpoint captures a screenshot of the specified webpage using Chromium. Users can customize the viewport dimensions and capture options.
POST
/
tools
/
screenshot
Authorizations
apiKey
string
queryrequiredAPI key passed as a query parameter
Body
application/json
url
string
The URL of the webpage to capture.
width
integer
default: 1280The width of the browser viewport in pixels.
height
integer
default: 720The height of the browser viewport in pixels.
image_quality
integer
default: 100Quality of the output image, on the range 1-100. 100 will not perform any compression.
wait
integer
default: 0Duration in milliseconds to wait after page has loaded, mainly used for sites with JS animations.
scroll_all_content
boolean
If true, scrolls the page and captures all visible content.
capture_full_height
boolean
If true, captures the entire height of the page, ignoring the viewport height.
s3_target_address
string
Presigned S3 url target to upload the image to.
Response
200 - image/png
The response is of type file.