{ "openapi": "3.0.1", "info": { "title": "HTML to PDF — Render URL or HTML to PDF", "description": "Render any URL or raw HTML into a pixel-accurate PDF with headers, footers, margins and page size. Generate invoices, reports and receipts from templates in an n8n or Make workflow.", "version": "1.0", "x-build-id": "fTgIFo5szP7yths43" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hipersoft~html-to-pdf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hipersoft-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/hipersoft~html-to-pdf/runs": { "post": { "operationId": "runs-sync-hipersoft-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/hipersoft~html-to-pdf/run-sync": { "post": { "operationId": "run-sync-hipersoft-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": { "url": { "title": "URL", "type": "string", "description": "A web page URL to render to PDF. Leave empty to use raw HTML." }, "html": { "title": "Raw HTML", "type": "string", "description": "Raw HTML to render (used when no URL is given) — great for invoices/reports from a template." }, "format": { "title": "Page format", "enum": [ "A4", "A3", "A5", "Letter", "Legal", "Tabloid" ], "type": "string", "description": "Paper size.", "default": "A4" }, "landscape": { "title": "Landscape", "type": "boolean", "description": "Landscape orientation.", "default": false }, "printBackground": { "title": "Print backgrounds", "type": "boolean", "description": "Include background colors/images.", "default": true }, "scale": { "title": "Scale", "type": "string", "description": "Render scale (0.1–2).", "default": "1" }, "marginTop": { "title": "Margin top", "type": "string", "description": "e.g. 10mm.", "default": "10mm" }, "marginBottom": { "title": "Margin bottom", "type": "string", "description": "e.g. 10mm.", "default": "10mm" }, "marginLeft": { "title": "Margin left", "type": "string", "description": "e.g. 10mm.", "default": "10mm" }, "marginRight": { "title": "Margin right", "type": "string", "description": "e.g. 10mm.", "default": "10mm" }, "headerHtml": { "title": "Header HTML", "type": "string", "description": "Optional header template (supports date, title, pageNumber classes)." }, "footerHtml": { "title": "Footer HTML", "type": "string", "description": "Optional footer template." }, "outputName": { "title": "Output filename", "type": "string", "description": "Name for the PDF.", "default": "document.pdf" } } }, "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 } } } } } } } } } }