{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot & PDF: Full Page, Mobile, Dark Mode",
    "description": "Screenshot any list of URLs as PNG, JPEG or WebP, full page or viewport, on desktop, tablet, mobile or a custom size, with optional PDF, dark mode and cookie banners hidden. $2 per 1,000 screenshots plus $0.002 per run; URLs that fail, are blocked or never load are free.",
    "version": "0.1",
    "x-build-id": "5UI3goE2CcrZ7QVsp"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/wisekit~website-screenshot/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-wisekit-website-screenshot",
        "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/wisekit~website-screenshot/runs": {
      "post": {
        "operationId": "runs-sync-wisekit-website-screenshot",
        "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/wisekit~website-screenshot/run-sync": {
      "post": {
        "operationId": "run-sync-wisekit-website-screenshot",
        "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",
        "properties": {
          "urls": {
            "title": "URLs",
            "type": "array",
            "description": "Pages to capture, one per line: full URLs (\"https://example.com/pricing\") or bare domains (\"example.com\", opened as https). Up to 500 per run (10 on the Apify free plan). Duplicates are merged. Only public http and https pages: local, private-network and other addresses come back as invalid_url, free; sites whose owners asked us not to open them come back as excluded_by_request, free. Agent example: {\"urls\":[\"https://example.com\"]}.",
            "items": {
              "type": "string"
            }
          },
          "device": {
            "title": "Device",
            "enum": [
              "desktop",
              "tablet",
              "mobile",
              "custom"
            ],
            "type": "string",
            "description": "The screen to emulate. desktop: 1440x900. tablet: 820x1180 at 2x pixel density, touch, mobile layout. mobile: 390x844 at 2x pixel density, touch, mobile layout. custom: the width and height below at 1x. No extra cost. Example: \"mobile\". Default desktop.",
            "default": "desktop"
          },
          "width": {
            "title": "Custom width (px)",
            "minimum": 320,
            "maximum": 3840,
            "type": "integer",
            "description": "Only with device \"custom\": the browser window width in CSS pixels, 320 to 3840. No extra cost. Example: 1920. Default 1440."
          },
          "height": {
            "title": "Custom height (px)",
            "minimum": 240,
            "maximum": 2400,
            "type": "integer",
            "description": "Only with device \"custom\": the browser window height in CSS pixels, 240 to 2400. It is the image height unless \"Full page\" is on. No extra cost. Example: 1080. Default 900."
          },
          "fullPage": {
            "title": "Full page (the whole scrollable page)",
            "type": "boolean",
            "description": "On: the image shows the whole page from top to bottom, up to \"Max full-page height\". Off: only what fits in the window (the viewport). Same price either way. Example: true. Default off.",
            "default": false
          },
          "maxHeight": {
            "title": "Max full-page height (px)",
            "minimum": 1000,
            "maximum": 16000,
            "type": "integer",
            "description": "Full page only: the longest image, in CSS pixels, 1000 to 16000. Longer pages are cut at this height and the row gets a warning. Tablet and mobile images (2x density) are capped at 8000 CSS pixels (16,000 image pixels). No extra cost. Example: 15000. Default 10000.",
            "default": 10000
          },
          "format": {
            "title": "Image format",
            "enum": [
              "png",
              "jpeg",
              "webp"
            ],
            "type": "string",
            "description": "png (sharp, larger files), jpeg or webp (smaller files; set the quality below). A PNG over 9 MB is saved as JPEG instead, with a warning. No extra cost. Example: \"webp\". Default png.",
            "default": "png"
          },
          "quality": {
            "title": "JPEG / WebP quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "1 to 100, for jpeg and webp only (ignored for png). Higher is sharper and larger. No extra cost. Example: 90. Default 80.",
            "default": 80
          },
          "saveScreenshot": {
            "title": "Save a screenshot ($0.002 per image)",
            "type": "boolean",
            "description": "Save an image of each page (event screenshot, $0.002 per image saved). Turn off to save PDFs only. Example: true. Default on.",
            "default": true
          },
          "savePdf": {
            "title": "Also save a PDF (+$0.002 per PDF)",
            "type": "boolean",
            "description": "Also save each page as a PDF, the way the browser prints it (print styles, backgrounds on, 10 mm margins). Charged $0.002 per PDF saved (event pdf), on top of the screenshot. PDFs over 9 MB are not saved and not charged. Example: true. Default off.",
            "default": false
          },
          "pdfFormat": {
            "title": "PDF paper size",
            "enum": [
              "A4",
              "Letter"
            ],
            "type": "string",
            "description": "A4 or Letter. Only with \"Also save a PDF\". No extra cost. Example: \"Letter\". Default A4.",
            "default": "A4"
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Tell the page the visitor prefers a dark theme (prefers-color-scheme: dark). Sites with a dark theme show it; sites without one look the same. No extra cost. Example: true. Default off.",
            "default": false
          },
          "hideCookieBanners": {
            "title": "Hide cookie banners (best effort)",
            "type": "boolean",
            "description": "Hide the cookie and consent banners of common consent tools (OneTrust, Cookiebot, Usercentrics, Didomi, Quantcast, TrustArc and others) with CSS before the capture. Nothing is clicked or accepted; banners we don't recognise stay visible (add them to \"Hide these elements\"). Turn it off for compliance records or archives, so the page is captured unchanged. No extra cost. Example: true. Default on.",
            "default": true
          },
          "hideSelectors": {
            "title": "Hide these elements (CSS selectors)",
            "type": "array",
            "description": "CSS selectors of elements to hide before the capture, for example chat widgets, pop-ups or ads: \"#chat-widget\", \".newsletter-popup\". Up to 50. No extra cost.",
            "items": {
              "type": "string"
            }
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "When the page counts as loaded. load: the page and its images have loaded (good default). domcontentloaded: as soon as the HTML is ready (fastest). networkidle: no network traffic for half a second (slowest; some pages never go quiet). If the page isn't there in time, what has loaded is captured and the row gets a warning. No extra cost. Default load.",
            "default": "load"
          },
          "waitForSelector": {
            "title": "Wait for this element (CSS selector)",
            "type": "string",
            "description": "Optional. Wait until this element is visible before the capture, for example \"#main-chart\" or \".product-grid\". If it doesn't appear within the time limit, the URL comes back as selector_not_found and is not charged. No extra cost."
          },
          "delaySecs": {
            "title": "Extra delay before capture (seconds)",
            "minimum": 0,
            "maximum": 10,
            "type": "number",
            "description": "Seconds to wait after the page has loaded, so animations and late content can finish. 0 to 10. No extra cost. Example: 3. Default 1.",
            "default": 1
          },
          "scrollToBottom": {
            "title": "Scroll down first (lazy-loaded images)",
            "type": "boolean",
            "description": "Full page only: scroll through the page (at most 6 seconds) before the capture, so images that load on scroll appear. No extra cost. Example: true. Default off.",
            "default": false
          },
          "timeoutSecs": {
            "title": "Time limit per URL (seconds)",
            "minimum": 10,
            "maximum": 30,
            "type": "integer",
            "description": "The most time one URL can take, everything included (loading, waiting, capture), 10 to 30. A URL whose page has not started loading in time comes back as timeout, free; a page that is still loading is captured as it is, with a warning, and charged. No extra cost. Example: 20. Default 30.",
            "default": 30
          },
          "demo": {
            "title": "Demo (fictional sample rows, only the start fee)",
            "type": "boolean",
            "description": "Shows six fictional sample rows (captured, captured while still loading, timeout, bot check, HTTP 404, private address) and a sample image of a fictional page. No website is opened and no screenshot is charged; only the run start fee applies ($0.002 at the default 1 GB). The URLs you entered are ignored. Example: true. Default off.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}