For AI agents and LLMs: a machine-readable index is available at llms.txt. A plain-Markdown version of any documentation page is available by appending .md to its URL.
Skip to main content
Upload Screenshots›Upload any locally captured images to SmartUI for visual regression testing.Maximum Upload Size:100MB
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
Upload Screenshots

Upload any locally captured images to SmartUI for visual regression testing.Maximum Upload Size:100MB

Using this API you can upload any local images to our cloud comparsion. You can upload images and add their meta-data information to map the screenshots for comparsion.

POST
/v2/upload
Upload any locally captured images to SmartUI for visual regression testing.Maximum Upload Size:100MB
curl --request POST \
  --url "https://api.lambdatest.com/automation/smart-ui/v2/upload" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: multipart/form-data" \
  --form 'files=<files>' \
  --form 'projectToken=<projectToken>' \
  --form 'buildName=<buildName>' \
  --form 'baseline=true' \
  --form 'screenshotNames=<screenshotNames>' \
  --form 'githubURL=<githubURL>'
{
  "data": {
    "filesUploaded": {
      "error": "",
      "message": "",
      "fileName": "Screenshot 2022-12-05 at 5.00.37 PM.png",
      "screenshotName": "screenshot1"
    },
    "buildName": "build-1",
    "buildId": "f3e9bf89-4b61-4eb2-ad60-aaa72150d05e",
    "projectName": "demo-project",
    "totalFilesUploaded": 1,
    "projectId": "65bd1675-fe42-40bf-9698-7610cb4211bd"
  },
  "status": "success"
}

Authorizations

Authorizationstringheaderrequired

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

Body

multipart/form-data

Pass your list of screenshots which needs to be uploaded for comparison. (Minimum 1 file required)

filesstring<binary>required
projectTokenstringrequired
buildNamestring
baselineboolean
screenshotNamesstring
githubURLstring

Response

application/json

successful operation

dataobject
data.filesUploadedobject
data.buildNamestring
Example: "build-1"
data.buildIdstring
Example: "f3e9bf89-4b61-4eb2-ad60-aaa72150d05e"
data.projectNamestring
Example: "demo-project"
data.totalFilesUploadednumber
Example: 1
data.projectIdstring
Example: "65bd1675-fe42-40bf-9698-7610cb4211bd"
statusstring
Upload any locally captured images to SmartUI for visual regression testing.Maximum Upload Size:100MB
curl --request POST \
  --url "https://api.lambdatest.com/automation/smart-ui/v2/upload" \
  --header "Authorization: Basic <encoded-value>" \
  --header "Content-Type: multipart/form-data" \
  --form 'files=<files>' \
  --form 'projectToken=<projectToken>' \
  --form 'buildName=<buildName>' \
  --form 'baseline=true' \
  --form 'screenshotNames=<screenshotNames>' \
  --form 'githubURL=<githubURL>'
{
  "data": {
    "filesUploaded": {
      "error": "",
      "message": "",
      "fileName": "Screenshot 2022-12-05 at 5.00.37 PM.png",
      "screenshotName": "screenshot1"
    },
    "buildName": "build-1",
    "buildId": "f3e9bf89-4b61-4eb2-ad60-aaa72150d05e",
    "projectName": "demo-project",
    "totalFilesUploaded": 1,
    "projectId": "65bd1675-fe42-40bf-9698-7610cb4211bd"
  },
  "status": "success"
}