{ "openapi": "3.0.1", "info": { "title": "URL to PDF: Bulk Webpage & HTML to PDF, Failed Free", "description": "Webpage, website and HTML page to PDF in bulk from URLs: A4, Letter or Legal, margins, page numbers, optional merge. Failed URLs are never charged.", "version": "1.0", "x-build-id": "Cz8z4NS2h5IOR8nhN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/altronite~url-to-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-altronite-url-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/altronite~url-to-pdf/runs": { "post": { "operationId": "runs-sync-altronite-url-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/altronite~url-to-pdf/run-sync": { "post": { "operationId": "run-sync-altronite-url-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", "required": [ "urls" ], "properties": { "urls": { "title": "URLs", "maxItems": 500, "type": "array", "description": "Public pages to convert, one per line; each becomes its own PDF. A missing scheme defaults to https://. Up to 500 per run. Example: [\"https://example.com\", \"example.org/about\"].", "default": [ "https://apify.com" ], "items": { "type": "string" } }, "paperFormat": { "title": "Paper size", "enum": [ "A4", "Letter", "Legal" ], "type": "string", "description": "Page size of every PDF: A4 (210×297 mm), Letter (8.5×11 in) or Legal (8.5×14 in). Example: \"Letter\".", "default": "A4" }, "landscape": { "title": "Landscape", "type": "boolean", "description": "Print pages sideways (wide). Example: true for wide tables or dashboards.", "default": false }, "printBackground": { "title": "Print backgrounds", "type": "boolean", "description": "Include background colours and images, as on screen. Example: false for plain, ink-saving pages.", "default": true }, "mediaType": { "title": "CSS media", "enum": [ "print", "screen" ], "type": "string", "description": "Which of the site's styles to use: print (its print stylesheet, usually cleaner, menus often hidden) or screen (looks like the browser). Example: \"screen\".", "default": "print" }, "margin": { "title": "Margin (mm)", "minimum": 0, "maximum": 50, "type": "integer", "description": "Blank margin on all four sides, in millimetres, 0–50. With page numbers on, the bottom margin is at least 12 mm so the numbers fit. Example: 0 for edge-to-edge.", "default": 10 }, "pageNumbers": { "title": "Page numbers", "type": "boolean", "description": "Add a centred \"page / total\" footer to every page (no other header text). Example: true for reports.", "default": false }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page counts as loaded before printing. Network idle is safest for heavy single-page apps but slower. Example: \"networkidle\".", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Extra wait after load and before printing, e.g. for animations or late content. Max 30,000 ms. Example: 2000.", "default": 0 }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hide common consent pop-ups with CSS before printing. Nothing is clicked or accepted. Example: false to keep the page untouched.", "default": true }, "respectRobotsTxt": { "title": "Respect robots.txt", "type": "boolean", "description": "Skip URLs the site's robots.txt disallows (uncharged error row). Turn off only for pages you have the right to capture. Example: true.", "default": true }, "timeoutSecs": { "title": "Page timeout (seconds)", "minimum": 5, "maximum": 180, "type": "integer", "description": "Limit for each step: page loading, then PDF printing, each separately. Load and print errors are retried once; a print that runs past the limit is not. Example: 90 for very long pages.", "default": 45 }, "maxConcurrency": { "title": "Parallel pages", "minimum": 1, "maximum": 7, "type": "integer", "description": "Pages printed at the same time, 1–7 (default 2, sized for the default 1,024 MB memory). Allow about 400 MB of memory per parallel page; raise memory for heavy sites or higher concurrency. Example: 5 with 2,048 MB memory.", "default": 2 }, "mergeIntoOne": { "title": "Merge into one PDF", "type": "boolean", "description": "Also join all delivered PDFs, in input order, into merged.pdf with one bookmark per source URL. Needs at least 2 delivered PDFs totalling at most 10% of the run memory (about 102 MB at 1 GB); charged once per merged file. The single PDFs are kept too. Example: true.", "default": 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 } } } } } } } } } }