{
  "openapi": "3.0.1",
  "info": {
    "title": "Bulk Website Screenshots + PDF + Visual Change Detection",
    "description": "Screenshot hundreds of URLs per run: full page or viewport, desktop/laptop/tablet/mobile, PNG/JPEG/WebP, optional PDF. Hides cookie banners and chat widgets. Schedule it to detect visual changes since the last run.",
    "version": "0.1",
    "x-build-id": "KINftPRhHFGTK28Qa"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lindenbyte~bulk-website-screenshots/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lindenbyte-bulk-website-screenshots",
        "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/lindenbyte~bulk-website-screenshots/runs": {
      "post": {
        "operationId": "runs-sync-lindenbyte-bulk-website-screenshots",
        "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/lindenbyte~bulk-website-screenshots/run-sync": {
      "post": {
        "operationId": "run-sync-lindenbyte-bulk-website-screenshots",
        "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 per line (https:// is added if missing). Duplicates are removed. Each URL is captured once per selected device.",
            "items": {
              "type": "string"
            }
          },
          "devices": {
            "title": "Devices",
            "type": "array",
            "description": "One screenshot per URL per device. Desktop 1920x1080, Laptop 1366x768, Tablet 820x1180 @2x (iPad-like), Mobile 390x844 @2x (iPhone-like, mobile user agent and touch). Custom uses the size fields below.",
            "items": {
              "type": "string",
              "enum": [
                "desktop",
                "laptop",
                "tablet",
                "mobile",
                "custom"
              ],
              "enumTitles": [
                "Desktop 1920x1080",
                "Laptop 1366x768",
                "Tablet 820x1180 @2x",
                "Mobile 390x844 @2x",
                "Custom size (below)"
              ]
            },
            "default": [
              "desktop"
            ]
          },
          "fullPage": {
            "title": "Full-page screenshot",
            "type": "boolean",
            "description": "On = capture the whole scrollable page (up to the max height below). Off = only the visible viewport (above the fold).",
            "default": true
          },
          "format": {
            "title": "Image format",
            "enum": [
              "png",
              "jpeg",
              "webp"
            ],
            "type": "string",
            "description": "PNG is pixel-perfect but large for full pages; JPEG and WebP use the quality setting below.",
            "default": "png"
          },
          "quality": {
            "title": "JPEG/WebP quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Compression quality for JPEG and WebP (1-100). Ignored for PNG.",
            "default": 80
          },
          "savePdf": {
            "title": "Also save a PDF of each page",
            "type": "boolean",
            "description": "Print each URL to a PDF (one PDF per URL, not per device; print layout depends on the paper size, not the device). Charged per PDF.",
            "default": false
          },
          "pdfFormat": {
            "title": "PDF paper size",
            "enum": [
              "A4",
              "Letter",
              "Legal",
              "A3",
              "Tabloid"
            ],
            "type": "string",
            "description": "Paper size of the PDF.",
            "default": "A4"
          },
          "pdfLandscape": {
            "title": "PDF landscape",
            "type": "boolean",
            "description": "Landscape orientation for the PDF.",
            "default": false
          },
          "pdfMedia": {
            "title": "PDF look",
            "enum": [
              "screen",
              "print"
            ],
            "type": "string",
            "description": "Screen = the PDF looks like the website; Print = uses the site's print stylesheet (often hides menus and ads).",
            "default": "screen"
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "When the page counts as loaded. If the event is not reached in time the page is captured anyway, with a warning.",
            "default": "load"
          },
          "delayMs": {
            "title": "Extra delay before capture (ms)",
            "minimum": 0,
            "maximum": 60000,
            "type": "integer",
            "description": "Wait this long after loading (and scrolling) before taking the screenshot, for animations and late content.",
            "default": 1000
          },
          "waitForSelector": {
            "title": "Wait for CSS selector",
            "type": "string",
            "description": "Optional: wait until an element matching this CSS selector is visible (for example #main or .product-grid). If it never appears, the page is captured anyway with a warning."
          },
          "scrollToBottom": {
            "title": "Scroll to bottom first (lazy images)",
            "type": "boolean",
            "description": "For full-page shots: scroll down step by step (max 15 s) so lazy-loaded images and sections render, then scroll back to the top.",
            "default": true
          },
          "hideCookieBanners": {
            "title": "Hide cookie banners",
            "type": "boolean",
            "description": "Hide common cookie/consent popups (OneTrust, Cookiebot, Usercentrics, Didomi, Quantcast, Google consent, CookieYes, Complianz and more) with CSS and unlock page scrolling. Best effort: unknown or custom banners may remain; add their selectors below.",
            "default": true
          },
          "hideChatWidgets": {
            "title": "Hide chat widgets",
            "type": "boolean",
            "description": "Hide common chat bubbles (Intercom, HubSpot, Drift, Crisp, Tawk, Zendesk, Tidio, LiveChat and more). Best effort.",
            "default": true
          },
          "hideSelectors": {
            "title": "Extra CSS selectors to hide",
            "type": "array",
            "description": "Your own CSS selectors to hide before capture, one per line (for example .newsletter-popup or #promo-bar). Also useful in monitoring mode to hide rotating banners or clocks that would count as changes.",
            "items": {
              "type": "string"
            }
          },
          "customCss": {
            "title": "Custom CSS to inject",
            "type": "string",
            "description": "Optional CSS added to every page before capture, for example: header { position: static !important; }"
          },
          "blockAds": {
            "title": "Block ads and trackers",
            "type": "boolean",
            "description": "Block requests to ~45 common ad and analytics hosts (Google ads/analytics/tag manager, Meta pixel, Hotjar, Taboola, Outbrain, Criteo...). Faster, cleaner screenshots; the page may look slightly different from what visitors see.",
            "default": false
          },
          "compareWithPrevious": {
            "title": "Visual change detection (monitoring mode)",
            "type": "boolean",
            "description": "Compare each screenshot with the previous run's screenshot of the same URL and device. Adds changePercent, isChanged, previousCapturedAt and previousScreenshotUrl. The comparison data lives in your named key-value store 'bulk-screenshots-state'. Schedule the Actor to monitor pages.",
            "default": false
          },
          "changeThreshold": {
            "title": "Change threshold (% of pixels)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "A page counts as changed when at least this percent of (downscaled) pixels differ from the previous run. 0 = any difference. Raise it for pages with small rotating content.",
            "default": 1
          },
          "onlyChanged": {
            "title": "Output only changed pages",
            "type": "boolean",
            "description": "Monitoring mode: save and output only pages that changed since the previous run (plus the first capture of a new URL). Unchanged pages are compared but not saved or output. Turns on change detection automatically.",
            "default": false
          },
          "stateKey": {
            "title": "Monitor name (state key)",
            "type": "string",
            "description": "Monitoring mode: separate monitors (for example one per client or schedule) keep separate history when they use different names. Change it to start a fresh baseline.",
            "default": "default"
          },
          "customWidth": {
            "title": "Custom width (px)",
            "minimum": 200,
            "maximum": 3840,
            "type": "integer",
            "description": "Viewport width for the 'custom' device.",
            "default": 1280
          },
          "customHeight": {
            "title": "Custom height (px)",
            "minimum": 200,
            "maximum": 4320,
            "type": "integer",
            "description": "Viewport height for the 'custom' device (also the screenshot height when full page is off).",
            "default": 800
          },
          "customDeviceScaleFactor": {
            "title": "Custom pixel ratio",
            "minimum": 1,
            "maximum": 4,
            "type": "integer",
            "description": "Device pixel ratio for the 'custom' device: 2 = retina (image is twice the width and height).",
            "default": 1
          },
          "customIsMobile": {
            "title": "Custom device is mobile",
            "type": "boolean",
            "description": "Emulate a mobile browser (mobile user agent, touch, meta viewport) for the 'custom' device.",
            "default": false
          },
          "maxFullPageHeight": {
            "title": "Max full-page height (px)",
            "minimum": 500,
            "maximum": 16384,
            "type": "integer",
            "description": "Full-page screenshots are cut at this height (CSS pixels; for @2x/@3x devices also limited to 16,384 image pixels). Endless-scroll pages are always cut here.",
            "default": 15000
          },
          "navigationTimeoutSecs": {
            "title": "Page load timeout (s)",
            "minimum": 5,
            "maximum": 180,
            "type": "integer",
            "description": "Maximum time to load a page.",
            "default": 45
          },
          "waitForSelectorTimeoutSecs": {
            "title": "Wait-for-selector timeout (s)",
            "minimum": 1,
            "maximum": 120,
            "type": "integer",
            "description": "How long to wait for the selector above.",
            "default": 15
          },
          "concurrency": {
            "title": "Pages in parallel",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many pages are captured at the same time. 2 is safe for the default 2 GB memory with heavy full-page sites; give 4 GB for 3-5 and 8 GB for 6-10.",
            "default": 2
          },
          "maxRetries": {
            "title": "Retries per page",
            "minimum": 0,
            "maximum": 5,
            "type": "integer",
            "description": "Retry a page this many times if it fails to load.",
            "default": 1
          },
          "maxUrls": {
            "title": "Max URLs per run",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Cost cap: only the first N URLs are captured. You can also set a max charge per run in the run options.",
            "default": 1000
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional. Off by default (direct connection). Use Apify Proxy if sites block data-center traffic or you need a specific country.",
            "default": {
              "useApifyProxy": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}