{ "openapi": "3.0.1", "info": { "title": "HTML to PDF Converter - Web Pages & Raw HTML, Bulk", "description": "Convert web pages or raw HTML (invoices, reports) to PDF in bulk: A4, Letter and more, margins, landscape, page numbers, backgrounds, cookie banners hidden. $2 per 1,000 PDFs.", "version": "1.0", "x-build-id": "CicMrKVcgYahgT3J7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/propped_cloak~html-to-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-propped_cloak-html-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/propped_cloak~html-to-pdf/runs": { "post": { "operationId": "runs-sync-propped_cloak-html-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/propped_cloak~html-to-pdf/run-sync": { "post": { "operationId": "run-sync-propped_cloak-html-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": "URLs to print to PDF, one per line. Duplicates are removed. Leave empty if you only convert raw HTML.", "items": { "type": "string" } }, "html": { "title": "Raw HTML", "type": "string", "description": "Optional. A full HTML document (invoice, report, certificate...) converted to one PDF. Images and styles can be loaded from public URLs. Up to 5 MB." }, "format": { "title": "Page format", "enum": [ "A4", "Letter", "Legal", "A3", "A5", "Tabloid" ], "type": "string", "description": "Paper size.", "default": "A4" }, "landscape": { "title": "Landscape", "type": "boolean", "description": "Wide pages instead of tall ones.", "default": false }, "margin": { "title": "Margins", "type": "string", "description": "Same margin on the 4 sides, with a unit: 10mm, 1cm, 0.5in or 20px.", "default": "10mm" }, "pageNumbers": { "title": "Page numbers", "type": "boolean", "description": "Adds \"page / total\" at the bottom of each page.", "default": false }, "printBackground": { "title": "Print backgrounds", "type": "boolean", "description": "Keep background colors and images, as on screen.", "default": true }, "media": { "title": "CSS media", "enum": [ "print", "screen" ], "type": "string", "description": "\"print\" uses the site's print styles (usually cleaner). \"screen\" keeps the on-screen look.", "default": "print" }, "scale": { "title": "Scale", "type": "string", "description": "Zoom of the content, from 0.1 to 2.", "default": "1" }, "hideCookieBanners": { "title": "Hide cookie banners", "type": "boolean", "description": "Hides consent banners and walls before printing. Nothing is accepted or refused.", "default": true }, "blockAds": { "title": "Block ads and trackers", "type": "boolean", "description": "Faster loading and cleaner documents.", "default": true }, "waitUntil": { "title": "Wait until", "enum": [ "load", "domcontentloaded", "networkidle" ], "type": "string", "description": "When the page is considered ready. Use networkidle for pages that load their content late.", "default": "load" }, "delayMs": { "title": "Extra delay (ms)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Wait this long after loading, for animations or late content.", "default": 300 }, "javascript": { "title": "Run JavaScript", "type": "boolean", "description": "Turn off to print the HTML exactly as written, without running its scripts.", "default": true } } }, "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 } } } } } } } } } }