Skip to main content
Start Screenshot Test›Start Screenshot Test
TestMu AI
StatusCommunityBlog
Selenium Automation API
Automated Screenshots API
App Automation API (Real Devices)
Smart UI
Cypress Automation
User Management
Test Manager
HyperExecute
Accessibility Testing
Analytics
Performance Testing
Audit logs
Start Screenshot Test

Start Screenshot Test

Start Screenshot Test

POST
Start Screenshot Test
curl --request POST \
  --url "https://api.lambdatest.com/screenshots/v1/" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "url": "<url>",
    "defer_time": 0,
    "email": true,
    "mac_res": "<mac_res>",
    "win_res": "<win_res>",
    "tunnel": true,
    "tunnel_identifier": "<tunnel_identifier>",
    "username": "<username>",
    "password": "<password>",
    "callback_url": "<callback_url>",
    "configs": "<configs>"
  }'
{
  "test_id": "TES100968331562243938913767"
}

Authorizations

Authorizationstringheaderrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

start screenshot test payload.

urlstring
defer_timenumber
emailboolean
mac_resstring
win_resstring
tunnelboolean
tunnel_identifierstring
usernamestring
passwordstring
callback_urlstring
configsobject

Response

application/json

successful operation

test_idstring
Start Screenshot Test
curl --request POST \
  --url "https://api.lambdatest.com/screenshots/v1/" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: application/json" \
  --data '{
    "url": "<url>",
    "defer_time": 0,
    "email": true,
    "mac_res": "<mac_res>",
    "win_res": "<win_res>",
    "tunnel": true,
    "tunnel_identifier": "<tunnel_identifier>",
    "username": "<username>",
    "password": "<password>",
    "callback_url": "<callback_url>",
    "configs": "<configs>"
  }'
{
  "test_id": "TES100968331562243938913767"
}