{ "openapi": "3.0.1", "info": { "title": "Convert PDF, Word & Web Pages to Markdown + RAG Chunks", "description": "Convert PDF, Word (.docx) and web pages into clean Markdown, with optional RAG chunks. Offline for files. Price per page or document (see events). Failed files free. Works from Apify MCP and the API.", "version": "1.0", "x-build-id": "IYuxOm0zrfY2qIZ92" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidybytetools~doc-to-markdown/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidybytetools-doc-to-markdown", "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/tidybytetools~doc-to-markdown/runs": { "post": { "operationId": "runs-sync-tidybytetools-doc-to-markdown", "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/tidybytetools~doc-to-markdown/run-sync": { "post": { "operationId": "run-sync-tidybytetools-doc-to-markdown", "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": [ "fileUrls" ], "properties": { "fileUrls": { "title": "File links", "type": "array", "description": "Links to PDF files, Word (.docx) files or web pages. A PDF or Word link must download the file itself.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "chunks": { "title": "Make chunks for AI search (RAG)", "type": "boolean", "description": "Also cut each file into chunks. Each chunk keeps its heading path and page numbers. Chunks are free.", "default": true }, "outputMode": { "title": "Dataset layout", "enum": [ "documents", "chunks" ], "type": "string", "description": "How results are laid out in the dataset. The full Markdown file is always saved in the key-value store too.", "default": "documents" }, "chunkSize": { "title": "Chunk size (characters)", "minimum": 100, "maximum": 20000, "type": "integer", "description": "About how long each chunk is. 1,500 characters is about 375 tokens.", "default": 1500 }, "chunkOverlap": { "title": "Chunk overlap (characters)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "How much text the next chunk repeats from the one before, so ideas aren't cut in half.", "default": 200 }, "pages": { "title": "PDF pages", "type": "string", "description": "Which PDF pages to read, like 1,3-5. Leave empty for all pages." }, "tables": { "title": "Tables in PDFs", "enum": [ "lines", "text", "off" ], "type": "string", "description": "Tables become real Markdown tables. Word and web page tables are always kept.", "default": "lines" }, "ocr": { "title": "Scanned PDF pages (OCR)", "enum": [ "auto", "never" ], "type": "string", "description": "Pages that are only a picture are read with OCR. Each one costs $0.005.", "default": "auto" }, "keepPageMenus": { "title": "Keep web page menus and footers", "type": "boolean", "description": "Off: we drop menus, side bars and footers from web pages, so you get just the main text.", "default": false }, "maxPagesPerPdf": { "title": "Max pages per PDF", "minimum": 1, "maximum": 5000, "type": "integer", "description": "We read at most this many pages from each PDF. Keeps costs in check on very long files.", "default": 300 } } }, "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 } } } } } } } } } }