Capture screenshot of a web page

Capture screenshot of the specified URL with optional configuration. Returns binary image data by default for optimal performance.

POST /v1/web/screenshot

Capture screenshot of a web page

cURL

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
  }
}
'

import requests

url = "https://api.weblinq.dev/v1/web/screenshot"

payload = {
    "url": "<string>",
    "waitTime": 0,
    "base64": False,
    "screenshotOptions": {},
    "viewport": {
        "height": 800,
        "width": 1280,
        "deviceScaleFactor": 1,
        "hasTouch": False,
        "isLandscape": False,
        "isMobile": False
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    waitTime: 0,
    base64: false,
    screenshotOptions: {},
    viewport: {
      height: 800,
      width: 1280,
      deviceScaleFactor: 1,
      hasTouch: false,
      isLandscape: false,
      isMobile: false
    }
  })
};

fetch('https://api.weblinq.dev/v1/web/screenshot', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.weblinq.dev/v1/web/screenshot",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => '<string>',
    'waitTime' => 0,
    'base64' => false,
    'screenshotOptions' => [
        
    ],
    'viewport' => [
        'height' => 800,
        'width' => 1280,
        'deviceScaleFactor' => 1,
        'hasTouch' => false,
        'isLandscape' => false,
        'isMobile' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.weblinq.dev/v1/web/screenshot"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"waitTime\": 0,\n  \"base64\": false,\n  \"screenshotOptions\": {},\n  \"viewport\": {\n    \"height\": 800,\n    \"width\": 1280,\n    \"deviceScaleFactor\": 1,\n    \"hasTouch\": false,\n    \"isLandscape\": false,\n    \"isMobile\": false\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.weblinq.dev/v1/web/screenshot")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"waitTime\": 0,\n  \"base64\": false,\n  \"screenshotOptions\": {},\n  \"viewport\": {\n    \"height\": 800,\n    \"width\": 1280,\n    \"deviceScaleFactor\": 1,\n    \"hasTouch\": false,\n    \"isLandscape\": false,\n    \"isMobile\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.weblinq.dev/v1/web/screenshot")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"waitTime\": 0,\n  \"base64\": false,\n  \"screenshotOptions\": {},\n  \"viewport\": {\n    \"height\": 800,\n    \"width\": 1280,\n    \"deviceScaleFactor\": 1,\n    \"hasTouch\": false,\n    \"isLandscape\": false,\n    \"isMobile\": false\n  }\n}"

response = http.request(request)
puts response.read_body

200

"<string>"

{
  "success": false,
  "error": {
    "message": "Authentication required",
    "code": "UNAUTHORIZED",
    "requestId": "bf68e5de-f6ef-479f-9328-6d3f48d5b7d4"
  }
}

{
  "success": false,
  "error": {
    "issues": [
      {
        "code": "invalid_type",
        "expected": "string",
        "received": "undefined",
        "path": [
          "url"
        ],
        "message": "Required"
      }
    ],
    "name": "ZodError"
  }
}

{
  "success": false,
  "error": {
    "message": "Authentication required",
    "code": "UNAUTHORIZED",
    "requestId": "bf68e5de-f6ef-479f-9328-6d3f48d5b7d4"
  }
}

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

Show child attributes

viewport · object

Show child attributes

Response

200

image/png

Screenshot captured successfully - returns binary image data by default

Raw bytes; default response.