{ "openapi": "3.0.1", "info": { "title": "Website Screenshot API - Full Page PNG, JPEG & PDF (Bulk URLs)", "description": "Capture full-page or viewport screenshots of many URLs as PNG, JPEG or PDF, on desktop, tablet or mobile. Hides cookie banners, waits for selectors, returns public file links, HTTP status, title and size. Respects robots.txt. Flat price per screenshot. By IntegriApps.", "version": "0.1", "x-build-id": "mlPmtbmCtdk46KyeX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/integriapps~website-screenshot/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-integriapps-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/integriapps~website-screenshot/runs": { "post": { "operationId": "runs-sync-integriapps-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/integriapps~website-screenshot/run-sync": { "post": { "operationId": "run-sync-integriapps-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": "URLs", "type": "array", "description": "Web pages to capture (one screenshot per URL). If empty, https://example.com/ is captured for free as a demo. LinkedIn, Instagram, Facebook, TikTok, X/Twitter, Google (Search/Maps) and Amazon are not supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "format": { "title": "Format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG (lossless), JPEG (smaller files) or PDF (printable document).", "default": "png" }, "device": { "title": "Device", "enum": [ "desktop", "tablet", "mobile" ], "type": "string", "description": "Desktop (1366×768), tablet (820×1180, 2x) or mobile (390×844, 2x, touch, mobile user agent).", "default": "desktop" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the visible viewport (PNG/JPEG).", "default": true }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 240, "maximum": 3840, "type": "integer", "description": "Optional. Overrides the device width (240–3840)." }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 240, "maximum": 4320, "type": "integer", "description": "Optional. Overrides the device height (240–4320)." }, "maxFullPageHeight": { "title": "Max full-page height (px)", "minimum": 500, "maximum": 20000, "type": "integer", "description": "Very long pages are cut at this height (CSS pixels) to keep files usable. 500–20,000.", "default": 10000 }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "Only for JPEG (1–100).", "default": 80 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3" ], "type": "string", "description": "Only for PDF.", "default": "A4" }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page is considered loaded: 'load' (default), 'domcontentloaded' (faster) or 'networkidle' (waits up to 15 s for network to be quiet; best for heavy JavaScript pages).", "default": "load" }, "waitForSelector": { "title": "Wait for CSS selector", "type": "string", "description": "Optional. Wait until this element is visible before capturing, e.g. #main-chart" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Optional extra wait before capturing (0–30,000 ms), e.g. for animations.", "default": 0 }, "scrollToLoadLazyContent": { "title": "Scroll to load lazy images", "type": "boolean", "description": "For full-page and PDF captures, scroll down the page first so lazy-loaded images appear.", "default": true }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common cookie/consent banners with CSS (OneTrust, Cookiebot, Usercentrics, Didomi, Quantcast and others). Nothing is clicked or accepted; unknown banners may still show.", "default": true }, "hideSelectors": { "title": "Extra CSS selectors to hide", "type": "string", "description": "Optional comma-separated CSS selectors to hide, e.g. .chat-widget, #newsletter-popup" }, "customCss": { "title": "Custom CSS", "type": "string", "description": "Optional CSS injected before capturing." }, "navigationTimeoutSecs": { "title": "Page load timeout (s)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time to load each page (5–120 s).", "default": 30 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for timeouts, network errors, HTTP 429 and 5xx (0–5).", "default": 2 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pages captured in parallel (1–10). Higher values need 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 } } } } } } } } } }