POST
/
v1
/
tools
/
screenshot
curl --request POST \
  --url https://api.anchorbrowser.io/v1/tools/screenshot \
  --header 'Content-Type: application/json' \
  --header 'anchor-api-key: <api-key>' \
  --data '{
  "url": "https://anchorbrowser.io",
  "width": 1280,
  "height": 720,
  "image_quality": 70,
  "wait": 200,
  "scroll_all_content": true,
  "capture_full_height": true,
  "s3_target_address": "https://your-bucket.s3.amazonaws.com/your/object/key?X-Amz-Signature=..."
}'
This response does not have an example.

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Query Parameters

​
sessionId
string

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

Body

application/json
​
url
string

The URL of the webpage to capture.

Example:

"https://anchorbrowser.io"

​
width
integer

The width of the browser viewport in pixels.

Example:

1280

​
height
integer

The height of the browser viewport in pixels.

Example:

720

​
image_quality
integer

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

Example:

70

​
wait
integer

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

200
image/png
Screenshot successfully captured.

The response is of type file.