{ "openapi": "3.0.1", "info": { "title": "Website to PDF: Convert URLs and HTML to PDF Files", "description": "Turn web pages or your own HTML into PDF files in bulk with a real Chrome browser: A4, Letter and more, landscape, margins, header and footer with page numbers, one long single-page PDF, print or screen styles, cookie banners hidden.", "version": "0.1", "x-build-id": "HdInFR6tZslaAQvQA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidelane~website-to-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidelane-website-to-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/tidelane~website-to-pdf/runs": { "post": { "operationId": "runs-sync-tidelane-website-to-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/tidelane~website-to-pdf/run-sync": { "post": { "operationId": "run-sync-tidelane-website-to-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": "Web pages", "type": "array", "description": "Pages to convert, one per line. \"example.com\" works too (https is added).", "items": { "type": "string" } }, "html": { "title": "Or your own HTML", "type": "string", "description": "A complete HTML document (up to 5 MB) to turn into a PDF, for example an invoice or report template. Images and styles may load from the web." }, "fileName": { "title": "File name for the HTML PDF", "type": "string", "description": "Used for the PDF made from your own HTML." }, "format": { "title": "Paper size", "enum": [ "A4", "Letter", "Legal", "A3", "A5", "Tabloid" ], "type": "string", "description": "Page size of the PDF.", "default": "A4" }, "landscape": { "title": "Landscape", "type": "boolean", "description": "Wide pages instead of tall ones.", "default": false }, "singlePage": { "title": "One long page", "type": "boolean", "description": "The whole site on a single page exactly as wide and tall as on screen (up to 14,400 px tall), no page breaks. Ignores paper size.", "default": false }, "marginMm": { "title": "Margin (mm)", "minimum": 0, "maximum": 50, "type": "integer", "description": "White border on every side.", "default": 10 }, "headerFooter": { "title": "Header and footer", "type": "boolean", "description": "Page title and date on top; URL and page numbers (3 / 12) at the bottom.", "default": false }, "media": { "title": "Styles", "enum": [ "screen", "print" ], "type": "string", "description": "Screen: looks like the website. Print: uses the site's print styles (often without menus and ads).", "default": "screen" }, "printBackground": { "title": "Print backgrounds", "type": "boolean", "description": "Keep background colors and images.", "default": true }, "scale": { "title": "Scale", "type": "string", "description": "Zoom of the content, 0.1 to 2. Below 1 fits more on a page.", "default": "1" }, "pageRanges": { "title": "Pages", "type": "string", "description": "Only these pages, for example 1-3, 5. Empty means all." }, "preferCssPageSize": { "title": "Use the page size from the site's CSS", "type": "boolean", "description": "If the HTML sets @page { size: ... }, use it instead of the paper size.", "default": false }, "device": { "title": "Screen width", "enum": [ "desktop", "laptop", "tablet", "mobile" ], "type": "string", "description": "The browser window the page is laid out for.", "default": "desktop" }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides the consent pop-ups of common tools. Nothing is clicked, no consent is given.", "default": true }, "scrollToLoad": { "title": "Scroll to load images", "type": "boolean", "description": "Scroll through the page first so lazy-loaded images appear.", "default": true }, "delayMs": { "title": "Extra wait (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Wait this long after loading, for animations or late content.", "default": 500 }, "waitUntil": { "title": "Page loaded when", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "networkidle waits until no more requests run (slower, for heavy sites).", "default": "load" }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip pages whose robots.txt forbids automated access. Turn off only for your own sites or with the owner's permission.", "default": true }, "timeoutSecs": { "title": "Timeout per page (s)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Pages that take longer fail and are not charged.", "default": 60 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 5, "type": "integer", "description": "More is faster but needs more memory (about 500 MB per page).", "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 } } } } } } } } } }