{ "openapi": "3.0.1", "info": { "title": "Website Screenshot & PDF Capture - Full Page, Any Viewport", "description": "Capture any web page as a PNG, JPEG or PDF. Full-page or viewport, custom size and scale, wait-for-selector support for pages that load late.", "version": "0.1", "x-build-id": "jmW6jKJKgMwFDQQSc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/samer-samaha~site-screenshot-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-samer-samaha-site-screenshot-pro", "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/samer-samaha~site-screenshot-pro/runs": { "post": { "operationId": "runs-sync-samer-samaha-site-screenshot-pro", "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/samer-samaha~site-screenshot-pro/run-sync": { "post": { "operationId": "run-sync-samer-samaha-site-screenshot-pro", "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 to capture", "type": "array", "description": "List of web page URLs to screenshot or convert to PDF. You can paste one or many.", "default": [ "https://apify.com" ], "items": { "type": "string" } }, "format": { "title": "Output format", "enum": [ "png", "jpeg", "pdf" ], "type": "string", "description": "Choose PNG or JPEG for an image, or PDF to save the page as a document.", "default": "png" }, "fullPage": { "title": "Capture full page", "type": "boolean", "description": "When on, captures the entire scrollable page instead of just the visible area. Ignored for PDF (PDFs always paginate the full page).", "default": true }, "waitUntil": { "title": "Navigation wait condition", "enum": [ "domcontentloaded", "load", "commit" ], "type": "string", "description": "How the browser decides the page has started loading before it looks for extra readiness signals. 'domcontentloaded' works for almost all sites.", "default": "domcontentloaded" }, "waitForNetworkIdle": { "title": "Wait for network to go quiet", "type": "boolean", "description": "After the page loads, wait a bit longer for background requests (images, fonts, analytics) to settle down before capturing. Recommended for most sites.", "default": true }, "networkIdleTimeout": { "title": "Network idle wait timeout (ms)", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Maximum time to wait for the network to go quiet before capturing anyway. Prevents the run from hanging on pages with constant background activity.", "default": 12000 }, "waitForSelector": { "title": "Wait for a specific element (CSS selector)", "type": "string", "description": "Optional. If the page loads content dynamically, give a CSS selector (e.g. '#main-content') and the capture will wait until it appears.", "default": "" }, "extraWaitMs": { "title": "Extra fixed wait (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Optional extra pause after all other waiting, useful for slow animations or lazy-loaded images.", "default": 0 }, "viewportWidth": { "title": "Viewport width (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Width of the simulated browser window used for the capture.", "default": 1280 }, "viewportHeight": { "title": "Viewport height (px)", "minimum": 200, "maximum": 3840, "type": "integer", "description": "Height of the simulated browser window used for the capture.", "default": 800 }, "timeout": { "title": "Page load timeout (ms)", "minimum": 1000, "maximum": 120000, "type": "integer", "description": "Maximum time to wait for the page to load before giving up on that URL.", "default": 30000 }, "pdfFormat": { "title": "PDF page size", "enum": [ "A4", "A3", "A2", "A1", "A0", "A5", "A6", "Letter", "Legal", "Tabloid", "Ledger" ], "type": "string", "description": "Paper size to use when the output format is PDF.", "default": "A4" }, "landscape": { "title": "PDF landscape orientation", "type": "boolean", "description": "When on, PDF pages are generated in landscape orientation instead of portrait.", "default": false }, "omitBackground": { "title": "Transparent background", "type": "boolean", "description": "When on, removes the default white background — useful for PNG screenshots of elements with transparency. Has no effect on JPEG or PDF.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Requests go out through this proxy. The datacenter pool stalled on page loads in testing, so residential is the default; clear it entirely if you would rather use Apify own IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } }, "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 } } } } } } } } } }