Skip to main content
POST
/
v1
/
web
/
screenshot
Capture screenshot of a web page
curl --request POST \
  --url https://api.weblinq.dev/v1/web/screenshot \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "waitTime": 0,
  "base64": false,
  "screenshotOptions": {},
  "viewport": {
    "height": 800,
    "width": 1280,
    "deviceScaleFactor": 1,
    "hasTouch": false,
    "isLandscape": false,
    "isMobile": false
  }
}
'
"<string>"

Authorizations

​
Authorization
string
header
required

Enter your API token or session token

Body

application/json

Screenshot parameters

​
url
string<uri>
required
​
waitTime
integer
default:0
Required range: 0 <= x <= 5000
​
base64
boolean
default:false

Return base64 string instead of binary Uint8Array

​
screenshotOptions
object
​
viewport
object

Response

Screenshot captured successfully - returns binary image data by default

Raw bytes; default response.