{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot & PDF: Full Page, Most Cookie Banners Hidden",
    "description": "Screenshots (PNG, JPEG, WebP) and PDFs of web pages or HTML. Full page with lazy images, mobile presets, common cookie banners hidden. You pay only for files produced.",
    "version": "0.1",
    "x-build-id": "8SOnM11lbS2bOyAqK"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/far003~website-screenshot-pdf/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-far003-website-screenshot-pdf",
        "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/far003~website-screenshot-pdf/runs": {
      "post": {
        "operationId": "runs-sync-far003-website-screenshot-pdf",
        "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/far003~website-screenshot-pdf/run-sync": {
      "post": {
        "operationId": "run-sync-far003-website-screenshot-pdf",
        "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 addresses (URLs)",
            "type": "array",
            "description": "The web pages to capture, one file per address. Only http and https addresses are captured. An address that is not valid, or is not http/https, gives a free record with the reason; a page that answers an error (404, 500...), refuses (401, 403, 429), asks for a challenge, does not load in time, or points to a private network address gives a free record too. Use either this list, or the HTML field below, or both. Lists of addresses in a remote file (\"requestsFromUrl\") are not supported.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "html": {
            "title": "HTML page (optional)",
            "type": "string",
            "description": "A complete HTML page to render instead of (or besides) the addresses, for example an invoice or a report to turn into a PDF. Styles must be inline or in a <style> tag, and images must be data: addresses or absolute https addresses: relative addresses cannot be resolved. Up to 5 MB. The record has inputType \"html\" and no url."
          },
          "format": {
            "title": "Output format",
            "enum": [
              "png",
              "jpeg",
              "webp",
              "pdf"
            ],
            "type": "string",
            "description": "png (lossless, default), jpeg and webp (smaller, use Quality) or pdf. One file per address, stored in the key-value store of the run.",
            "default": "png"
          },
          "fullPage": {
            "title": "Full page",
            "type": "boolean",
            "description": "Capture the whole page, not only the first screen. Ignored for PDF (a PDF always contains the whole page) and when a selector is given. Pages taller than the maximum height are cut there and marked truncated: true.",
            "default": true
          },
          "maxFullPageHeight": {
            "title": "Maximum full page height (px)",
            "minimum": 100,
            "maximum": 16384,
            "type": "integer",
            "description": "Tallest capture in CSS pixels, from 100 to 16384 (the limit of Chromium). A page taller than this is cut at this height and the record says truncated: true and gives fullHeightPx. WebP cannot be taller than 16383 pixels, so 16383 is its cap.",
            "default": 16384
          },
          "quality": {
            "title": "Quality (JPEG and WebP)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "From 1 to 100. No effect on PNG and PDF.",
            "default": 80
          },
          "device": {
            "title": "Device",
            "enum": [
              "desktop",
              "desktop_hd",
              "laptop",
              "iphone_15",
              "iphone_se",
              "pixel_8",
              "ipad"
            ],
            "type": "string",
            "description": "The screen to emulate. Desktop is 1440 x 900. The phone and tablet presets also send a mobile browser identity and touch. Width and Height below override the size of the preset.",
            "default": "desktop"
          },
          "width": {
            "title": "Custom width (px)",
            "minimum": 200,
            "maximum": 3840,
            "type": "integer",
            "description": "Overrides the width of the device preset, from 200 to 3840. The record then says device: \"custom\"."
          },
          "height": {
            "title": "Custom height (px)",
            "minimum": 100,
            "maximum": 4320,
            "type": "integer",
            "description": "Overrides the height of the device preset, from 100 to 4320. It is the height of the first screen; with Full page the capture goes beyond it."
          },
          "deviceScaleFactor": {
            "title": "Pixel density (retina)",
            "minimum": 1,
            "maximum": 3,
            "type": "number",
            "description": "1 to 3. 2 gives a sharp retina image twice as wide and tall (4 times the pixels, so more memory and bigger files). Default 1.",
            "default": 1
          },
          "colorScheme": {
            "title": "Color scheme",
            "enum": [
              "light",
              "dark"
            ],
            "type": "string",
            "description": "Light or dark, for sites that follow the system setting (prefers-color-scheme).",
            "default": "light"
          },
          "selector": {
            "title": "Capture one element (CSS selector)",
            "type": "string",
            "description": "For example #pricing-table or .hero. Only that element is captured (the first one that matches). If nothing matches, the record is empty_capture and free. Ignored for PDF."
          },
          "waitUntil": {
            "title": "Wait until",
            "enum": [
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "When the page counts as loaded. load (default) waits for the load event; domcontentloaded is faster; networkidle also waits for the network to be quiet, at most 15 seconds more (a page that never gets quiet is still captured).",
            "default": "load"
          },
          "waitForSelector": {
            "title": "Wait for element (CSS selector)",
            "type": "string",
            "description": "Wait until this element is in the page (up to 20 seconds) before capturing. If it does not show up the record is timeout and free."
          },
          "delayMs": {
            "title": "Extra delay (ms)",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Wait this long after the page has loaded and scrolled, for animations or late content. 0 to 10000.",
            "default": 0
          },
          "scrollToBottom": {
            "title": "Scroll to load lazy images",
            "type": "boolean",
            "description": "Before a full page, PDF or element capture, scroll down the page step by step so that lazy-loaded images and sections load, then go back to the top. Capped at 12 seconds and at the maximum height, so an endless page cannot hang the run.",
            "default": true
          },
          "cookieBanners": {
            "title": "Cookie banners",
            "enum": [
              "hide",
              "off"
            ],
            "type": "string",
            "description": "hide (default) hides the banners of the common consent platforms (OneTrust, Cookiebot, Didomi, Usercentrics, Sourcepoint, Quantcast and similar) and frees a page they froze. It never clicks Accept: this Actor gives no consent on your behalf. Best effort: a banner that is not recognised stays. off leaves the page as it is.",
            "default": "hide"
          },
          "hideSelectors": {
            "title": "Hide elements (CSS selectors)",
            "type": "array",
            "description": "Elements to hide before the capture, for example chat widgets or sticky bars. Up to 50 selectors.",
            "items": {
              "type": "string"
            }
          },
          "customCss": {
            "title": "Custom CSS",
            "type": "string",
            "description": "CSS added to the page before the capture, up to 20,000 characters."
          },
          "blockAds": {
            "title": "Block advertising",
            "type": "boolean",
            "description": "Do not load requests to a short, fixed list of advertising networks (about 25 domains, such as doubleclick.net and googlesyndication.com). It is not a general tracker blocker.",
            "default": false
          },
          "pdfFormat": {
            "title": "PDF paper size",
            "enum": [
              "A3",
              "A4",
              "A5",
              "Letter",
              "Legal",
              "Tabloid"
            ],
            "type": "string",
            "description": "Paper size when the format is pdf.",
            "default": "A4"
          },
          "pdfLandscape": {
            "title": "PDF landscape",
            "type": "boolean",
            "description": "Print the PDF in landscape orientation.",
            "default": false
          },
          "pdfMargins": {
            "title": "PDF margins",
            "type": "object",
            "description": "For example {\"top\": \"10mm\", \"right\": \"10mm\", \"bottom\": \"10mm\", \"left\": \"10mm\"} (the default). Units: mm, cm, in or px.",
            "default": {
              "top": "10mm",
              "right": "10mm",
              "bottom": "10mm",
              "left": "10mm"
            }
          },
          "pdfPrintBackground": {
            "title": "PDF background colors and images",
            "type": "boolean",
            "description": "Print the backgrounds of the page (on by default; browsers drop them from printouts otherwise).",
            "default": true
          },
          "pdfMedia": {
            "title": "PDF style sheet",
            "enum": [
              "print",
              "screen"
            ],
            "type": "string",
            "description": "print (default) uses the print styles of the page, as a browser Save as PDF does, and respects @page rules (good for invoices and articles). screen keeps the look of the screen.",
            "default": "print"
          },
          "cookies": {
            "title": "Cookies (secret)",
            "type": "array",
            "description": "Cookies to send, for pages behind a login. A list of objects with name, value and a domain (or url), for example [{\"name\": \"session\", \"value\": \"...\", \"domain\": \"example.com\"}]. A cookie without domain or url is refused: it would be sent to every address of the run. Never written to the log or to the output."
          },
          "headers": {
            "title": "Extra HTTP headers (secret)",
            "type": "object",
            "description": "For example {\"Authorization\": \"Bearer ...\"}. Sent only to the address of each page itself, never to the third-party resources it loads. Host, Cookie, User-Agent and similar headers are ignored. Never written to the log or to the output."
          },
          "basicAuth": {
            "title": "Basic authentication (secret)",
            "type": "object",
            "description": "For example {\"username\": \"user\", \"password\": \"...\"}. Sent only to the origin of each page. Never written to the log or to the output."
          },
          "timeoutSecs": {
            "title": "Timeout per address (seconds)",
            "minimum": 2,
            "maximum": 120,
            "type": "integer",
            "description": "A page that has not been captured in this time is given up (record timeout, free) so that the run never hangs. A timeout, a reset connection or a 5xx answer is tried once more. From 2 to 120.",
            "default": 45
          },
          "maxConcurrency": {
            "title": "Pages in parallel",
            "minimum": 1,
            "maximum": 6,
            "type": "integer",
            "description": "From 1 to 6. With the default memory (2048 MB) 3 is comfortable; heavy captures (retina, very tall pages) need fewer or more memory.",
            "default": 3
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}