{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF Generator", "description": "Batch full-page screenshots (PNG/JPEG) and PDFs of public web pages, with mobile/desktop presets and cookie-banner hiding. Pay per screenshot.", "version": "1.0", "x-build-id": "GNWWSsc9OKOMmJU2x" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thriving_adder~website-screenshot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thriving_adder-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/thriving_adder~website-screenshot-pdf/runs": { "post": { "operationId": "runs-sync-thriving_adder-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/thriving_adder~website-screenshot-pdf/run-sync": { "post": { "operationId": "run-sync-thriving_adder-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "type": "array", "description": "Public web pages to capture (max 10,000 per run). Login-protected, localhost and private-network URLs are rejected and not charged.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "outputFormats": { "title": "Output formats", "type": "array", "description": "Each format is charged as one result.", "items": { "type": "string", "enum": [ "png", "jpeg", "pdf" ], "enumTitles": [ "PNG screenshot", "JPEG screenshot", "PDF document" ] }, "default": [ "png" ] }, "fullPage": { "title": "Full page", "type": "boolean", "description": "Capture the whole scrollable page instead of only the viewport.", "default": true }, "maxPageHeightPx": { "title": "Max full-page height (px)", "minimum": 1000, "maximum": 32768, "type": "integer", "description": "Very tall pages are clipped at this height (flagged as heightTruncated) to avoid timeouts and out-of-memory errors. If a full-page capture still times out, the Actor falls back once to the top 4,000 px (flagged with 'fallback').", "default": 10000 }, "viewport": { "title": "Device preset", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "Viewport preset.", "default": "desktop" }, "viewportWidth": { "title": "Custom width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Overrides preset width." }, "viewportHeight": { "title": "Custom height (px)", "minimum": 200, "maximum": 4320, "type": "integer", "description": "Overrides preset height." }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Navigation event to wait for.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Wait after load before capture.", "default": 0 }, "scrollToBottom": { "title": "Scroll to load lazy images", "type": "boolean", "description": "Scroll through the page first so lazy-loaded images render.", "default": false }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides common consent popups with CSS. Never clicks Accept.", "default": true }, "hideSelectors": { "title": "CSS selectors to hide", "type": "array", "description": "Extra elements to hide (chat widgets, ads...).", "default": [], "items": { "type": "string" } }, "jpegQuality": { "title": "JPEG quality", "minimum": 10, "maximum": 100, "type": "integer", "description": "Only for JPEG.", "default": 80 }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3" ], "type": "string", "description": "Only for PDF.", "default": "A4" }, "pdfPrintBackground": { "title": "PDF background graphics", "type": "boolean", "description": "Only for PDF.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip (and do not charge for) URLs that the site's robots.txt disallows for automated agents. Turn off only for sites you own or have permission to capture.", "default": true }, "navigationTimeoutSecs": { "title": "Navigation timeout (s)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Per page.", "default": 45 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Parallel pages.", "default": 5 }, "maxRequestRetries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries per failed page for non-timeout errors (failed pages are not charged). Timeouts are not retried.", "default": 1 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. Datacenter proxy is usually enough.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }