{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot + Change Detection — Full Page, Mobile, PDF",
    "description": "Bulk website screenshots on desktop, tablet and mobile: full page or visible area, PNG, JPEG or PDF, cookie banners hidden. Website change monitor: each run is compared with the last for website monitoring and visual regression, with changed % and a diff image. From $1 per 1,000 screenshots.",
    "version": "0.0",
    "x-build-id": "suyTeX42EtcRscHsH"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/saliga~website-screenshot-change-detection/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-saliga-website-screenshot-change-detection",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/saliga~website-screenshot-change-detection/runs": {
      "post": {
        "operationId": "runs-sync-saliga-website-screenshot-change-detection",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/saliga~website-screenshot-change-detection/run-sync": {
      "post": {
        "operationId": "run-sync-saliga-website-screenshot-change-detection",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "urls"
        ],
        "properties": {
          "urls": {
            "title": "URLs",
            "type": "array",
            "description": "Web pages to capture. One screenshot per URL and device.",
            "items": {
              "type": "string"
            }
          },
          "devices": {
            "title": "Devices",
            "type": "array",
            "description": "Capture each URL on every selected device. Desktop 1920x1080, laptop 1366x768, tablet (iPad) 820x1180, mobile (iPhone) 390x844, Android 412x915.",
            "items": {
              "type": "string",
              "enum": [
                "desktop",
                "laptop",
                "tablet",
                "mobile",
                "android"
              ],
              "enumTitles": [
                "Desktop 1920x1080",
                "Laptop 1366x768",
                "Tablet (iPad) 820x1180",
                "Mobile (iPhone) 390x844",
                "Android 412x915"
              ]
            },
            "default": [
              "desktop"
            ]
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "Capture the whole scrollable page instead of only the visible area. Full-page captures are priced separately because they take about 10x more compute.",
            "default": false
          },
          "format": {
            "title": "Format",
            "enum": [
              "png",
              "jpeg",
              "pdf"
            ],
            "type": "string",
            "description": "PNG (sharp, larger), JPEG (smaller) or PDF. PDF is priced as a full-page capture.",
            "default": "png"
          },
          "detectChanges": {
            "title": "Detect visual changes since the last run",
            "type": "boolean",
            "description": "Compare every screenshot with the one from the previous run of this monitor and report whether the page changed, how much (% of pixels), and an image that highlights the changes. Schedule the Actor to monitor pages. The first run only saves the baseline. PNG and JPEG only.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Keep separate baselines for different lists of pages, for example \"competitor-pricing\". Baselines are kept in a named key-value store in your account."
          },
          "minChangePercent": {
            "title": "Minimum change to report (%)",
            "minimum": 0,
            "maximum": 100,
            "type": "number",
            "description": "Report a page as changed only when more than this share of pixels differs. Raise it to ignore small things like a clock or a rotating banner.",
            "default": 0.1
          },
          "baselineMode": {
            "title": "Compare with",
            "enum": [
              "previous",
              "fixed"
            ],
            "type": "string",
            "description": "Previous run: each run is compared with the one before. Fixed: keep the first capture as the reference until you change the monitor name.",
            "default": "previous"
          },
          "hideCookieBanners": {
            "title": "Hide cookie banners",
            "type": "boolean",
            "description": "Hide common cookie and consent pop-ups (OneTrust, Cookiebot, Usercentrics, Didomi, Quantcast and more).",
            "default": true
          },
          "clickAcceptCookies": {
            "title": "Click \"Accept\" on cookie banners",
            "type": "boolean",
            "description": "Some sites keep the page blurred until consent is given. When on, the Actor clicks a known accept button before hiding the banner.",
            "default": true
          },
          "hideSelectors": {
            "title": "Hide these elements",
            "type": "array",
            "description": "CSS selectors to hide before the capture, for example chat widgets or ads: \"#intercom-container\", \".ad-slot\".",
            "items": {
              "type": "string"
            }
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "When the page counts as loaded. \"Network idle\" is best for heavy JavaScript sites but slower.",
            "default": "load"
          },
          "waitForSelector": {
            "title": "Wait for element",
            "type": "string",
            "description": "Optional CSS selector to wait for before the capture."
          },
          "delayMs": {
            "title": "Extra delay (ms)",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Wait this long after loading, for animations to finish.",
            "default": 0
          },
          "scrollToBottom": {
            "title": "Scroll to load lazy images",
            "type": "boolean",
            "description": "For full-page captures, scroll down once so lazy-loaded images appear, then capture.",
            "default": true
          },
          "maxHeightPx": {
            "title": "Maximum page height (px)",
            "minimum": 1000,
            "maximum": 50000,
            "type": "integer",
            "description": "Very long pages are cut at this height and marked truncated. Pages taller than one capture are taken one screen at a time and joined, up to 50,000 px (60,000 image pixels on high-density devices).",
            "default": 16000
          },
          "colorScheme": {
            "title": "Color scheme",
            "enum": [
              "light",
              "dark",
              "no-preference"
            ],
            "type": "string",
            "description": "Ask the site for its light or dark theme.",
            "default": "light"
          },
          "quality": {
            "title": "JPEG quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "1-100. Only for JPEG.",
            "default": 80
          },
          "deviceScaleFactor": {
            "title": "Pixel density",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "Override the device pixel ratio (1-3). Leave empty to use each device's default."
          },
          "pdfFormat": {
            "title": "PDF page size",
            "enum": [
              "A4",
              "Letter",
              "Legal",
              "A3",
              "Tabloid"
            ],
            "type": "string",
            "description": "Paper size for PDF output.",
            "default": "A4"
          },
          "locale": {
            "title": "Locale",
            "type": "string",
            "description": "Browser language, for example \"de-DE\" or \"tr-TR\"."
          },
          "timezoneId": {
            "title": "Time zone",
            "type": "string",
            "description": "For example \"Europe/Berlin\"."
          },
          "headers": {
            "title": "Extra HTTP headers",
            "type": "object",
            "description": "Headers sent with every page request, for example an Authorization header for a staging site you own."
          },
          "cookies": {
            "title": "Cookies",
            "type": "array",
            "description": "Cookies to set before loading, in Playwright format: [{\"name\":\"session\",\"value\":\"...\",\"domain\":\"example.com\",\"path\":\"/\"}]. Only for sites you are allowed to access."
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. Use a proxy to capture a page as seen from another country."
          },
          "concurrency": {
            "title": "Parallel captures",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many pages to capture at the same time. Apify gives 1 CPU core per 4 GB of memory; raise the run memory if you raise this.",
            "default": 2
          },
          "timeoutSecs": {
            "title": "Timeout per page (s)",
            "minimum": 5,
            "maximum": 120,
            "type": "integer",
            "description": "Give up on a page after this many seconds.",
            "default": 45
          },
          "maxRetries": {
            "title": "Retries",
            "minimum": 0,
            "maximum": 3,
            "type": "integer",
            "description": "Retry a page this many times when it fails to load. Failed pages are never charged.",
            "default": 1
          },
          "debug": {
            "title": "Debug log",
            "type": "boolean",
            "description": "Write every step of every capture to the log. Useful when a page fails.",
            "default": false
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}