{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot API",
    "description": "Website Screenshot — Full Pages, Elements, HTML & PDF Prints: `screenshot-captured` previous/requested $0.0015; `pdf-rendered` previous/requested $0.003; `browser-started` requested $0.001 (only if active); active Apify record sets fees; usage included; start extra; failed results uncharged.",
    "version": "1.0",
    "x-build-id": "Vjtf3kGZv5bsKxFOd"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/hermeskd~website-screenshot/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-hermeskd-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/hermeskd~website-screenshot/runs": {
      "post": {
        "operationId": "runs-sync-hermeskd-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/hermeskd~website-screenshot/run-sync": {
      "post": {
        "operationId": "run-sync-hermeskd-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": "Page URLs",
            "minItems": 1,
            "maxItems": 50,
            "type": "array",
            "description": "Page URLs, 1–50 per run. Give urls or html. Use direct public HTTP(S) URLs that permit automated access; robots rules and source limits apply. Supply 1–50 URLs per run.",
            "items": {
              "type": "string",
              "pattern": "^https?://[^\\s/@]+([/?#]\\S*)?$"
            }
          },
          "html": {
            "title": "Raw HTML",
            "maxLength": 2097152,
            "type": "string",
            "description": "Raw HTML to render instead of URLs (≤ 2 MB). Give urls or html."
          },
          "format": {
            "title": "Format",
            "enum": [
              "png",
              "jpeg",
              "webp",
              "pdf"
            ],
            "type": "string",
            "description": "png, jpeg or webp image; pdf prints the page. Accepted values: png, jpeg, webp, pdf.",
            "default": "png"
          },
          "quality": {
            "title": "Quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "JPEG and WebP quality, 1–100. Accepted range: 1–100, inclusive.",
            "default": 85
          },
          "omitBackground": {
            "title": "Transparent background",
            "type": "boolean",
            "description": "PNG and WebP only: where the page sets no background, the image is transparent instead of white.",
            "default": false
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "Capture the whole scroll height (up to 16,384 px); false captures the viewport.",
            "default": true
          },
          "device": {
            "title": "Device",
            "enum": [
              "desktop",
              "desktop-hd",
              "desktop-1440",
              "laptop",
              "square",
              "tablet",
              "ipad-pro",
              "mobile",
              "iphone",
              "iphone-se",
              "android"
            ],
            "type": "string",
            "description": "Viewport preset (CSS pixels): desktop 1280×800, desktop-hd 1920×1080, desktop-1440 1440×900, laptop 1366×768, square 1080×1080; mobile-type tablet 820×1180, ipad-pro 1024×1366, mobile 390×844, iphone 393×852, iphone-se 375×667, android 412×915. width and height override it.",
            "default": "desktop"
          },
          "width": {
            "title": "Viewport width",
            "minimum": 240,
            "maximum": 3840,
            "type": "integer",
            "description": "Custom viewport width in CSS pixels (240–3,840), over the device preset's. Accepted range: 240–3840, inclusive."
          },
          "height": {
            "title": "Viewport height",
            "minimum": 240,
            "maximum": 4320,
            "type": "integer",
            "description": "Custom viewport height in CSS pixels (240–4,320), over the device preset's. Accepted range: 240–4320, inclusive."
          },
          "deviceScaleFactor": {
            "title": "Device scale factor",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "1 (default), 2 or 3: retina-style captures with 2× or 3× the pixels. Accepted range: 1–3, inclusive.",
            "default": 1
          },
          "selector": {
            "title": "Selector",
            "maxLength": 500,
            "type": "string",
            "description": "Capture only this element (CSS selector)."
          },
          "clip": {
            "title": "Clip region",
            "type": "object",
            "description": "Capture only this rectangle of the page, in page pixels: {\"x\": 0, \"y\": 0, \"width\": 800, \"height\": 600}. Not with selector or pdf."
          },
          "hideSelectors": {
            "title": "Hide selectors",
            "maxItems": 20,
            "type": "array",
            "description": "Up to 20 CSS selectors hidden in the capture (visibility: hidden), at your request — for example a chat widget.",
            "items": {
              "type": "string"
            }
          },
          "waitForSelector": {
            "title": "Wait for selector",
            "maxLength": 500,
            "type": "string",
            "description": "Wait for this element before capture (≤ 15 s)."
          },
          "delayMs": {
            "title": "Delay (ms)",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Extra wait before capture, ≤ 10,000 ms. Accepted range: 0–10000, inclusive.",
            "default": 0
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "ready",
              "load",
              "networkidle"
            ],
            "type": "string",
            "description": "ready (default): the document, its fonts and 0.5 s without network requests, at most 5 s. load or networkidle wait for that first, at most 15 s more.",
            "default": "ready"
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Emulate a dark colour scheme.",
            "default": false
          },
          "blockAds": {
            "title": "Block ads and trackers",
            "type": "boolean",
            "description": "On by default: requests to ad, tracker and analytics hosts on HaGeZi's Multi LIGHT list (GPL-3.0) are not loaded, which also makes captures faster. The page itself is never edited, and the input URL's own site is never blocked. Set false to load everything.",
            "default": true
          },
          "blockCookieBanners": {
            "title": "Block cookie banners",
            "type": "boolean",
            "description": "Do not load consent-management platforms (OneTrust, Cookiebot, Usercentrics and others), so their cookie banners are not drawn. Nothing is ever accepted on your behalf.",
            "default": false
          },
          "blockImages": {
            "title": "Block images",
            "type": "boolean",
            "description": "Do not load images (faster text-only captures).",
            "default": false
          },
          "locale": {
            "title": "Locale",
            "maxLength": 35,
            "type": "string",
            "description": "Browser language, for example de-DE (navigator.language and Accept-Language)."
          },
          "timezone": {
            "title": "Time zone",
            "maxLength": 64,
            "type": "string",
            "description": "IANA time zone, for example Europe/Berlin."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}