{ "openapi": "3.0.1", "info": { "title": "Document to Markdown: PDF, Word, Excel, PowerPoint, EPUB", "description": "Converts PDF, Word (.docx), Excel (.xlsx, .xls, .csv), PowerPoint (.pptx), EPUB and HTML files from URLs into clean Markdown for LLMs and RAG: headings, paragraphs and tables kept, optional chunks with page numbers. Obeys robots.txt. $0.003 per document.", "version": "0.1", "x-build-id": "zhe6Fr8cyZLusUosk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nebulacolors~document-to-markdown/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nebulacolors-document-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/nebulacolors~document-to-markdown/runs": { "post": { "operationId": "runs-sync-nebulacolors-document-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/nebulacolors~document-to-markdown/run-sync": { "post": { "operationId": "run-sync-nebulacolors-document-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": [ "urls" ], "properties": { "urls": { "title": "Document URLs", "type": "array", "description": "One per line: PDF, Word (.docx), Excel (.xlsx, .xls, .ods, .csv), PowerPoint (.pptx), EPUB or HTML files, like https://example.com/report.pdf. The type is read from the file itself, so addresses without an extension work too.", "items": { "type": "string" } }, "chunkSize": { "title": "Chunk size (characters)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "For a RAG index: split each document into chunks of about this many characters, at paragraph ends where possible. Each chunk says which pages (or slides, sheets, chapters) it covers. 0 gives the Markdown only.", "default": 0 }, "ocr": { "title": "Read scanned pages (OCR)", "type": "boolean", "description": "Reads PDF pages that have no text, like scans and photographed pages, with Tesseract OCR. Each page read this way is one ocr-page event on top of the document's price; pages that already have text are never read again. Off: a PDF that is all scanned pages gives a free error row.", "default": false }, "ocrLanguages": { "title": "OCR languages", "type": "array", "description": "The languages of the scanned text. Pick only the ones in your documents: each extra language makes reading slower and a little less accurate.", "items": { "type": "string", "enum": [ "eng", "deu", "fra", "spa", "ita", "por", "nld", "pol", "swe", "dan", "nor", "fin", "ces", "ron", "hun", "tur", "ell", "rus", "ukr", "ara", "heb", "hin", "vie", "ind", "chi_sim", "chi_tra", "jpn", "kor" ], "enumTitles": [ "English", "German", "French", "Spanish", "Italian", "Portuguese", "Dutch", "Polish", "Swedish", "Danish", "Norwegian", "Finnish", "Czech", "Romanian", "Hungarian", "Turkish", "Greek", "Russian", "Ukrainian", "Arabic", "Hebrew", "Hindi", "Vietnamese", "Indonesian", "Chinese (simplified)", "Chinese (traditional)", "Japanese", "Korean" ] }, "default": [ "eng" ] }, "pdfTables": { "title": "Find tables in PDFs", "type": "boolean", "description": "Finds tables on PDF pages from how the text lines up, with or without ruled lines, and writes them as Markdown tables in place. Each table also comes as rows and CSV in the tables field. Each page with a table is one table-page event on top of the document's price. Word, Excel and PowerPoint tables are always kept, free.", "default": false }, "maxFileSizeMb": { "title": "Max file size (MB)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Bigger files are skipped for free, with an error row that says so.", "default": 50 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Off by default. Turn on Apify Proxy for a site that blocks cloud servers.", "default": { "useApifyProxy": 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 } } } } } } } } } }