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
  }
}'
{
  "success": true,
  "data": {
    "image": "<string>",
    "metadata": {
      "width": 123,
      "height": 123,
      "format": "<string>",
      "size": 123,
      "url": "<string>",
      "timestamp": "<string>"
    },
    "permanentUrl": "<string>",
    "fileId": "<string>"
  },
  "creditsCost": 123,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Enter your API token or session token

Body

application/json

Screenshot parameters

The body is of type object.

Response

Screenshot captured successfully

The response is of type object.