{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF API - Full Page, Mobile, $1.50/1K", "description": "Capture any web page as a full-page PNG or JPEG screenshot or a print-ready PDF in a real Chrome browser. Desktop, tablet or mobile sizes, cookie banners hidden, direct download links. $1.50 per 1,000 pages.", "version": "0.1", "x-build-id": "SPTiOllN2q2v77PVS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/plotpointtech~website-screenshot-pdf-generator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-plotpointtech-website-screenshot-pdf-generator", "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/plotpointtech~website-screenshot-pdf-generator/runs": { "post": { "operationId": "runs-sync-plotpointtech-website-screenshot-pdf-generator", "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/plotpointtech~website-screenshot-pdf-generator/run-sync": { "post": { "operationId": "run-sync-plotpointtech-website-screenshot-pdf-generator", "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": { "startUrls": { "title": "Page URLs", "type": "array", "description": "The web pages to capture.", "default": [ { "url": "https://apify.com" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "PNG (sharp, larger files), JPEG (smaller files) or PDF (printable document).", "default": "png" }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page. Turn off to capture only the visible screen (viewport).", "default": true }, "device": { "title": "Device size", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Desktop 1920x1080, Laptop 1366x768, Tablet 768x1024 or Mobile 390x844. Tablet and mobile load the site's mobile layout.", "default": "desktop" }, "viewportWidth": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides the device width." }, "viewportHeight": { "title": "Custom height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Overrides the device height." }, "waitUntil": { "title": "Wait until", "enum": [ "networkidle", "load", "domcontentloaded" ], "type": "string", "description": "When the page counts as loaded. Network idle waits until the page stops loading resources (best for most sites).", "default": "networkidle" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Wait this long after loading before capturing, e.g. for animations.", "default": 0 }, "selector": { "title": "Capture only this element (CSS selector)", "type": "string", "description": "Optional, e.g. #main, .pricing-table. Images only." }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common cookie and consent pop-ups from the capture with CSS. Nothing is clicked or accepted.", "default": true }, "customCss": { "title": "Custom CSS", "type": "string", "description": "Optional CSS added to every page before capture, e.g. to hide a chat widget: .chat-widget { display: none !important; }" }, "jpegQuality": { "title": "JPEG quality", "minimum": 1, "maximum": 100, "type": "integer", "description": "1 to 100. Higher is sharper and larger.", "default": 80 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3", "Tabloid" ], "type": "string", "description": "Paper size for PDF output.", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Landscape orientation for PDF output.", "default": false }, "scrollToLoadLazyContent": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll through the page before a full-page capture so lazy-loaded images appear.", "default": true }, "maxFullPageHeight": { "title": "Maximum full-page height (px)", "minimum": 500, "maximum": 50000, "type": "integer", "description": "Very long pages are cut at this height.", "default": 10000 }, "captureErrorPages": { "title": "Capture error pages", "type": "boolean", "description": "Also capture pages that return an HTTP error (404, 403, 500...). Off by default: such pages are skipped and not charged.", "default": false }, "pageTimeoutSecs": { "title": "Page timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Give up on a page after this long.", "default": 60 }, "maxConcurrency": { "title": "Pages at once", "minimum": 1, "maximum": 5, "type": "integer", "description": "How many pages to capture in parallel.", "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 } } } } } } } } } }