{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API — Full Page, Mobile & PDF", "description": "Screenshot any URL: full-page or viewport, desktop, tablet or mobile, JPEG, PNG or PDF. Hides cookie banners, loads lazy images, captures single elements. Returns a public image link per URL. Pay only for successful screenshots.", "version": "0.1", "x-build-id": "2GatJH5Nt65MgUik7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nefes-tools~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nefes-tools-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/nefes-tools~website-screenshot/runs": { "post": { "operationId": "runs-sync-nefes-tools-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/nefes-tools~website-screenshot/run-sync": { "post": { "operationId": "run-sync-nefes-tools-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": "Web pages to screenshot, one per line. Full URLs or bare domains (https:// is added). Each successful URL = one charged screenshot; failed pages are free.", "items": { "type": "string" } }, "format": { "title": "Format", "enum": [ "jpeg", "png", "pdf" ], "type": "string", "description": "JPEG (small, fast — best for most uses), PNG (lossless, much larger and slower on long pages) or PDF (the page as a document).", "default": "jpeg" }, "device": { "title": "Device", "enum": [ "desktop", "desktop-hd", "tablet", "mobile" ], "type": "string", "description": "Desktop 1280×800, Desktop HD 1920×1080, Tablet 820×1180 or Mobile 412×915 (Android Chrome).", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page. Turn off to capture only the visible viewport.", "default": true }, "scrollToBottom": { "title": "Load lazy images", "type": "boolean", "description": "Scroll through the page before a full-page screenshot, so images that load on scroll are shown instead of empty placeholders. Adds a few seconds per page.", "default": true }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide cookie and consent pop-ups (OneTrust, Cookiebot, Didomi, Usercentrics, custom banners) with CSS. Nothing is clicked or accepted. 'Accept or subscribe' walls are not hidden — they are a condition of access; such pages are flagged with consentWall=true.", "default": true }, "delayMs": { "title": "Delay before capture (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long after the page loads, so animations and lazy content can settle.", "default": 1000 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded. 'Network idle' is slower but safer for heavy pages.", "default": "load" }, "waitForSelector": { "title": "Wait for element (CSS selector)", "type": "string", "description": "Optional. Wait until this element appears before capturing, e.g. '#main-chart'." }, "elementSelector": { "title": "Capture only this element (CSS selector)", "type": "string", "description": "Optional. Screenshot just one element instead of the page, e.g. 'header' or '.pricing-table'. Ignored for PDF." }, "hideSelectors": { "title": "Hide elements (CSS selectors)", "type": "array", "description": "Optional. Elements to hide before capturing, e.g. chat widgets or sticky headers.", "items": { "type": "string" } }, "darkMode": { "title": "Dark mode", "type": "boolean", "description": "Ask the page for its dark color scheme (works on sites that support prefers-color-scheme).", "default": false }, "viewportWidth": { "title": "Custom viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Optional. Overrides the device width." }, "viewportHeight": { "title": "Custom viewport height (px)", "minimum": 200, "maximum": 2160, "type": "integer", "description": "Optional. Overrides the device height." }, "quality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1–100. Only used for JPEG.", "default": 80 }, "timeoutSecs": { "title": "Page timeout (s)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Give up on a page after this many seconds. Failed pages are not charged.", "default": 60 }, "maxHeight": { "title": "Maximum page height (px)", "minimum": 500, "maximum": 50000, "type": "integer", "description": "Full-page screenshots are cut at this height. Very tall pages (long articles, endless feeds) are slow and huge; 20,000 px covers almost every normal page.", "default": 20000 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many pages to capture at once. Each page needs about 1 GB of run memory; the Actor slows down automatically if memory runs out.", "default": 4 } } }, "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 } } } } } } } } } }