{
  "openapi": "3.0.1",
  "info": {
    "title": "Website Screenshot API: Full Page, Mobile, PDF & Bulk",
    "description": "Website screenshot API for any list of URLs: full page screenshots, first screen or one element as PNG, JPEG or WebP, and URL to PDF. Desktop, tablet and mobile. Hides cookie banners, keeps sticky headers in place, loads lazy images. Works with AI agents via MCP. Failed pages free.",
    "version": "0.1",
    "x-build-id": "sPWOWJ5Lv7E0S1aCC"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/makerio~website-screenshot/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-makerio-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/makerio~website-screenshot/runs": {
      "post": {
        "operationId": "runs-sync-makerio-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/makerio~website-screenshot/run-sync": {
      "post": {
        "operationId": "run-sync-makerio-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",
        "required": [
          "urls"
        ],
        "properties": {
          "urls": {
            "title": "URLs",
            "type": "array",
            "description": "Pages to capture, one per line. \"example.com\" works too: https:// is added.",
            "items": {
              "type": "string"
            }
          },
          "devices": {
            "title": "Devices",
            "type": "array",
            "description": "Each page is captured once per device. Desktop 1920×1080, laptop 1366×768, tablet 820×1180 (2×), phone 390×844 (3×). Phones and tablets get the site's mobile layout.",
            "items": {
              "type": "string",
              "enum": [
                "desktop",
                "laptop",
                "tablet",
                "mobile"
              ],
              "enumTitles": [
                "Desktop 1920×1080",
                "Laptop 1366×768",
                "Tablet 820×1180",
                "Phone 390×844"
              ]
            },
            "default": [
              "desktop"
            ]
          },
          "mode": {
            "title": "What to capture",
            "enum": [
              "fullPage",
              "viewport",
              "height",
              "element"
            ],
            "type": "string",
            "description": "Full page: top to bottom. First screen: what a visitor sees without scrolling. Fixed height: from the top down to \"Height\". Element: one part of the page chosen by a CSS selector.",
            "default": "fullPage"
          },
          "format": {
            "title": "File format",
            "enum": [
              "png",
              "jpeg",
              "webp",
              "pdf"
            ],
            "type": "string",
            "description": "PNG is lossless, JPEG and WebP are much smaller, PDF keeps text selectable.",
            "default": "png"
          },
          "selector": {
            "title": "Element selector",
            "type": "string",
            "description": "For \"One element\": a CSS selector such as #pricing, .hero or main. The first match is captured."
          },
          "height": {
            "title": "Height (px)",
            "minimum": 100,
            "maximum": 20000,
            "type": "integer",
            "description": "For \"Fixed height\": how many CSS pixels from the top of the page to capture.",
            "default": 1200
          },
          "quality": {
            "title": "JPEG / WebP quality",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "1–100. Lower means smaller files.",
            "default": 80
          },
          "hideCookieBanners": {
            "title": "Hide cookie banners",
            "type": "boolean",
            "description": "Hides consent pop-ups of common providers (OneTrust, Cookiebot, Didomi, Usercentrics, Quantcast and others) and other pinned boxes that talk about cookies. Nothing is clicked or accepted.",
            "default": true
          },
          "stickyElements": {
            "title": "Pinned headers and widgets",
            "enum": [
              "smart",
              "keep",
              "hide"
            ],
            "type": "string",
            "description": "For full-page and fixed-height captures. Smart: headers pinned to the top stay once at the top; chat buttons, bars and pop-ups pinned to the screen are hidden so they don't float over the page. Keep: leave everything. Hide: hide all pinned elements, headers too.",
            "default": "smart"
          },
          "hideSelectors": {
            "title": "Also hide",
            "type": "array",
            "description": "CSS selectors of anything else to hide, for example .ad-slot or #newsletter-popup.",
            "items": {
              "type": "string"
            }
          },
          "blockAds": {
            "title": "Block ads and chat widgets",
            "type": "boolean",
            "description": "Blocks common ad networks and chat widgets, so ad slots stay empty, no chat bubble covers the page, and pages render faster. Analytics and tracking pixels are always blocked: they never show on a screenshot.",
            "default": true
          },
          "darkMode": {
            "title": "Dark mode",
            "type": "boolean",
            "description": "Ask the page for its dark theme (prefers-color-scheme: dark), if it has one.",
            "default": false
          },
          "waitUntil": {
            "title": "Wait for",
            "enum": [
              "smart",
              "load",
              "domcontentloaded",
              "networkidle"
            ],
            "type": "string",
            "description": "Smart: the load event, then up to 3 s of network quiet, web fonts and images. A page that never finishes loading is still captured once its content is there.",
            "default": "smart"
          },
          "scrollToLoad": {
            "title": "Scroll to load lazy content",
            "type": "boolean",
            "description": "Before a full-page capture, scroll down the page quickly (at most 8 s) so lazy images and sections load, then return to the top.",
            "default": true
          },
          "delay": {
            "title": "Extra delay (ms)",
            "minimum": 0,
            "maximum": 30000,
            "type": "integer",
            "description": "Wait this long after loading, for animations or slow widgets.",
            "default": 0
          },
          "timeoutSecs": {
            "title": "Page timeout (s)",
            "minimum": 10,
            "maximum": 180,
            "type": "integer",
            "description": "Give up on a page after this many seconds. Pages that fail are not charged.",
            "default": 45
          },
          "customWidth": {
            "title": "Custom width (px)",
            "minimum": 200,
            "maximum": 3840,
            "type": "integer",
            "description": "Adds a custom device with this window width (200–3840)."
          },
          "customHeight": {
            "title": "Custom height (px)",
            "minimum": 200,
            "maximum": 4320,
            "type": "integer",
            "description": "Window height of the custom device (200–4320)."
          },
          "deviceScaleFactor": {
            "title": "Pixel density",
            "minimum": 1,
            "maximum": 3,
            "type": "integer",
            "description": "Overrides the devices' pixel density: 1 for normal, 2 for retina-sharp images. Higher means bigger files."
          },
          "maxHeight": {
            "title": "Maximum full-page height (px)",
            "minimum": 500,
            "maximum": 50000,
            "type": "integer",
            "description": "Very long pages are cut here. Images are also kept under 16,384 device pixels in height, the limit for a reliable capture.",
            "default": 20000
          },
          "pdfFormat": {
            "title": "PDF paper size",
            "enum": [
              "A4",
              "Letter",
              "Legal",
              "A3",
              "Tabloid"
            ],
            "type": "string",
            "description": "For PDF output.",
            "default": "A4"
          },
          "pdfMedia": {
            "title": "PDF look",
            "enum": [
              "screen",
              "print"
            ],
            "type": "string",
            "description": "Screen: the PDF looks like the page on screen. Print: the site's print style, if it has one.",
            "default": "screen"
          },
          "maxConcurrency": {
            "title": "Pages at a time",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many pages to open in parallel. Empty: chosen from the run's memory (about three per 4 GB)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}