Skip to main content
POST
/
tools
/
screenshot
"<string>"

Authorizations

​
apiKey
string
query
required

API key passed as a query parameter

Query Parameters

​
sessionId
string

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

Body

application/json
​
url
string

The URL of the webpage to capture.

Example:

"https://anchorbrowser.io"

​
width
integer
default:1280

The width of the browser viewport in pixels.

Example:

1280

​
height
integer
default:720

The height of the browser viewport in pixels.

Example:

720

​
image_quality
integer
default:100

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

Example:

70

​
wait
integer
default:0

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

Example:

200

​
scroll_all_content
boolean

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

Example:

true

​
capture_full_height
boolean

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

Example:

true

​
s3_target_address
string

Presigned S3 url target to upload the image to.

Example:

"https://your-bucket.s3.amazonaws.com/your/object/key?X-Amz-Signature=..."

Response

Screenshot successfully captured.

The response is of type file.