Create

POST /api/projects/:projectId

Request Parameters#

Parameter	Type	Mandatory	Description
`screenshotParameter`	ScreenshotParameter	yes	Screenshot Configuration
`urls`	Array of UrlConfig	yes	URLs of Screenshots
`scheduledTs`	number	no	Timestamp in future when to schedule a Screenshot Job
`scheduleDescription`	ScheduleDescription	no	A description to schedule a Job

Example Request#

{
  "screenshotParameter": {
    "width": 1200,
    "height": 720,
    "style": "macos-simple-dark",
    "loginParameter": {
      "username": {
        "elementId": "#email",
        "username": "adam@websiteshot.app"
      },
      "password": {
        "elementId": "#password",
        "password": "s3cret"
      },
      "loginButton": {
        "elementId": "#login"
      }
    }
  },
  "urls": [
    {
      "url": "https://console.websiteshot.app/guarded",
      "name": "Just a Test",
      "loadingTime": 15000
    }
  ]
}

Response#

Attribute	Type	Description
`jobId`	string	JobId that you need to download all Screenshots

Example Response#

{
  "jobId": "abcdefgh-ijkl-mnop-qrst-uvwxyz"
}