{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & URL to PDF - Full Page, Bulk, HTML", "description": "Full page website screenshot and URL to PDF in bulk with headless Chromium. HTML to PDF, clip, viewport and paper size. Failed pages are never billed.", "version": "0.1", "x-build-id": "gIaYoqolg1a4rHCRC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pennydata~shot-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pennydata-shot-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/pennydata~shot-pdf/runs": { "post": { "operationId": "runs-sync-pennydata-shot-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/pennydata~shot-pdf/run-sync": { "post": { "operationId": "run-sync-pennydata-shot-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", "properties": { "urls": { "title": "URLs", "type": "array", "description": "Public http(s) pages to capture.", "default": [ { "url": "https://example.com" }, { "url": "https://en.wikipedia.org/wiki/Web_scraping" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "htmlDocuments": { "title": "HTML documents", "type": "array", "description": "Optional inline HTML strings to render (HTML to PDF/screenshot).", "items": { "type": "string" } }, "mode": { "title": "Output", "enum": [ "screenshot", "pdf", "both" ], "type": "string", "description": "What to produce for each page.", "default": "screenshot" }, "format": { "title": "Screenshot format", "enum": [ "png", "jpeg" ], "type": "string", "description": "Image format for screenshots: png (lossless) or jpeg (smaller).", "default": "png" }, "fullPage": { "title": "Full-page screenshot", "type": "boolean", "description": "Capture the whole scrollable page instead of only the visible viewport.", "default": true }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Browser viewport width in pixels (200-3840).", "default": 1280 }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 200, "maximum": 4000, "type": "integer", "description": "Browser viewport height in pixels (200-4000).", "default": 800 }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "Page lifecycle event to wait for before capturing: load, domcontentloaded or networkidle.", "default": "load" }, "delayMs": { "title": "Extra delay before capture (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait after the page is ready and before capture, in milliseconds.", "default": 500 }, "waitForSelector": { "title": "Wait for CSS selector", "type": "string", "description": "Optional selector to wait for (max 15s) before capture." }, "pdfFormat": { "title": "PDF paper size", "enum": [ "A4", "Letter", "Legal", "A3" ], "type": "string", "description": "Paper size used for PDF output (A4, Letter, Legal or A3).", "default": "A4" }, "pdfLandscape": { "title": "PDF landscape", "type": "boolean", "description": "Render PDFs in landscape orientation instead of portrait.", "default": false }, "pdfPrintBackground": { "title": "PDF print backgrounds", "type": "boolean", "description": "Include CSS background colors and images in PDFs.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of pages captured in parallel (1-10).", "default": 3 }, "maxRetries": { "title": "Max retries per page", "minimum": 0, "maximum": 5, "type": "integer", "description": "How many times a failed page is retried before it is reported as failed (0-5).", "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 } } } } } } } } } }