{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot & PDF API (Bulk, No Cookie Banners)",
    "description": "Screenshot API for URL lists: full page PNG, JPEG or PDF per URL with the cookie and GDPR banner removed. Desktop, tablet and mobile presets, dark mode, element crop, wait for a selector. Blocked or failed pages are not charged.",
    "version": "1.0",
    "x-build-id": "k1ucOOIhMSnhGeQs0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/atesen-software~website-screenshot-pdf-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-atesen-software-website-screenshot-pdf-api",
        "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/atesen-software~website-screenshot-pdf-api/runs": {
      "post": {
        "operationId": "runs-sync-atesen-software-website-screenshot-pdf-api",
        "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/atesen-software~website-screenshot-pdf-api/run-sync": {
      "post": {
        "operationId": "run-sync-atesen-software-website-screenshot-pdf-api",
        "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",
            "minItems": 1,
            "type": "array",
            "description": "Public web pages to capture, one per line. http and https only. Pages that need a login are not supported. Addresses inside private networks (localhost, 10.x, 192.168.x and similar) are rejected.",
            "items": {
              "type": "string"
            }
          },
          "formats": {
            "title": "Formats",
            "type": "array",
            "description": "File types to create for each URL. Every delivered file is one billable result. A PDF is made once per URL, from the first device in your list.",
            "items": {
              "type": "string",
              "enum": [
                "png",
                "jpeg",
                "pdf"
              ],
              "enumTitles": [
                "PNG image",
                "JPEG image",
                "PDF document"
              ]
            },
            "default": [
              "png"
            ]
          },
          "devices": {
            "title": "Device presets",
            "type": "array",
            "description": "Desktop is 1440x900, tablet 820x1180 and mobile 390x844 (the mobile and tablet presets use a touch device and a mobile Chrome user agent). Pick several to get one image per device.",
            "items": {
              "type": "string",
              "enum": [
                "desktop",
                "tablet",
                "mobile"
              ],
              "enumTitles": [
                "Desktop",
                "Tablet",
                "Mobile"
              ]
            },
            "default": [
              "desktop"
            ]
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "Capture the whole scrollable page instead of only the first screen. The page is scrolled first so lazy-loaded images appear. Images are limited to 16,384 device pixels in height.",
            "default": true
          },
          "removeCookieBanners": {
            "title": "Remove cookie and GDPR banners",
            "type": "boolean",
            "description": "Clicks the reject or dismiss button of well-known consent tools and hides cookie banners, consent pop-ups and their dark overlays before the capture. Works for common consent platforms and most standard banners, not for every site.",
            "default": true
          },
          "hideSelectors": {
            "title": "Hide elements (CSS selectors)",
            "type": "array",
            "description": "CSS selectors of elements to hide before the capture, for example a chat widget (#intercom-container) or a sticky ad (.ad-banner). One selector per line.",
            "items": {
              "type": "string"
            }
          },
          "selector": {
            "title": "Crop to element (CSS selector)",
            "type": "string",
            "description": "Capture only this element, for example #main-chart or article. Applies to PNG and JPEG; a PDF always contains the whole page. If no element matches, the row gets status failed and is not charged."
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Ask the page for its dark color scheme (prefers-color-scheme: dark). Only sites that support a dark theme change their look.",
            "default": false
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "Navigation event to wait for. Load waits for images and styles, DOM content loaded is faster, network idle waits until the page stops fetching.",
            "default": "load"
          },
          "waitMs": {
            "title": "Extra wait (ms)",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Pause after the page has loaded, before the capture. Useful for animations and late widgets.",
            "default": 1000
          },
          "waitForSelector": {
            "title": "Wait for element (CSS selector)",
            "type": "string",
            "description": "Wait until this element exists in the page before the capture. If it does not show up in time, the row gets status failed and is not charged."
          },
          "timeoutSecs": {
            "title": "Timeout per URL (seconds)",
            "minimum": 5,
            "maximum": 120,
            "type": "integer",
            "description": "Maximum time for the page to load. A URL that does not load in time gets status failed and is not charged.",
            "default": 30
          },
          "jpegQuality": {
            "title": "JPEG quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Quality of JPEG files, 1 to 100. Lower values make smaller files.",
            "default": 80
          },
          "pdfFormat": {
            "title": "PDF paper size",
            "enum": [
              "A4",
              "Letter",
              "Legal",
              "A3",
              "Tabloid"
            ],
            "type": "string",
            "description": "Paper size of PDF files.",
            "default": "A4"
          },
          "pdfLandscape": {
            "title": "PDF landscape",
            "type": "boolean",
            "description": "Print PDFs in landscape orientation.",
            "default": false
          },
          "pdfPrintStyles": {
            "title": "PDF uses print styles",
            "type": "boolean",
            "description": "Off: the PDF looks like the page on screen. On: the page's print stylesheet is used, which often hides menus and backgrounds.",
            "default": false
          },
          "viewportWidth": {
            "title": "Custom viewport width (px)",
            "minimum": 200,
            "maximum": 3840,
            "type": "integer",
            "description": "Overrides the width of every device preset. Leave empty to use the presets."
          },
          "viewportHeight": {
            "title": "Custom viewport height (px)",
            "minimum": 200,
            "maximum": 4000,
            "type": "integer",
            "description": "Overrides the height of every device preset. Leave empty to use the presets."
          },
          "captureErrorPages": {
            "title": "Capture error pages",
            "type": "boolean",
            "description": "Off: pages that answer with an HTTP error (404, 500 and similar) or show a bot wall are reported as failed or blocked and are free. On: error pages are captured and charged like any other page.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Parallel pages",
            "minimum": 1,
            "maximum": 6,
            "type": "integer",
            "description": "How many pages are captured at the same time. 2 is safe with 2048 MB of memory. Use 1 with 1024 MB, or raise memory to 4096 MB before using 4 or more with very long pages.",
            "default": 2
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}