{ "openapi": "3.0.1", "info": { "title": "Document to Markdown - PDF, DOCX, PPTX, XLSX, OCR & RAG Chunks", "description": "Convert PDF, Word, PowerPoint, Excel/CSV, HTML, EPUB and images to clean Markdown, text and RAG chunks with page numbers and heading paths. Tables kept, OCR for scans (eng+spa default). From US$0.50 per 1,000 pages.", "version": "0.1", "x-build-id": "9KSJf3rgo7VtF5me0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fabrikit~document-to-markdown/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fabrikit-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/fabrikit~document-to-markdown/runs": { "post": { "operationId": "runs-sync-fabrikit-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/fabrikit~document-to-markdown/run-sync": { "post": { "operationId": "run-sync-fabrikit-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", "properties": { "urls": { "title": "Document URLs", "type": "array", "description": "Direct links to PDF, DOCX, PPTX, XLSX/XLS/ODS, CSV, HTML, EPUB, TXT/MD or image (PNG, JPG, TIFF, WEBP, BMP, GIF) files. Google Drive and Dropbox share links and Google Docs/Sheets/Slides links (public) are supported.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "files": { "title": "Uploaded files", "type": "array", "description": "Optional: upload documents from your computer (stored in a key-value store of your account and passed to the Actor as URLs)." }, "ocr": { "title": "OCR for scans", "enum": [ "auto", "always", "never" ], "type": "string", "description": "Auto: OCR only pages without a text layer (scanned PDFs) and images. Always: OCR every PDF page. Never: skip OCR (scanned pages come out empty). OCR pages are billed with the extra OCR event.", "default": "auto" }, "ocrLanguages": { "title": "OCR languages", "type": "string", "description": "Tesseract language codes joined with +, for example eng+spa (default), deu, fra, por, ita, chi_sim, jpn, rus. Up to 5. English and Spanish are built in; others are downloaded on first use.", "default": "eng+spa" }, "enableChunking": { "title": "Create RAG chunks", "type": "boolean", "description": "Add a `chunks` array: overlapping text pieces with pageStart/pageEnd and the heading path, ready for a vector database.", "default": false }, "chunkSize": { "title": "Chunk size (characters)", "minimum": 100, "maximum": 20000, "type": "integer", "description": "Target maximum size of a chunk. Blocks (paragraphs, tables) are kept whole when they fit.", "default": 1000 }, "chunkOverlap": { "title": "Chunk overlap (characters)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Characters repeated from the end of the previous chunk. Must be smaller than the chunk size.", "default": 100 }, "includeText": { "title": "Include plain text", "type": "boolean", "description": "Add a `text` field with the document as plain text (no Markdown syntax).", "default": true }, "includePages": { "title": "Include per-page output", "type": "boolean", "description": "Add a `pages` array with the Markdown of every page / slide / sheet / chapter separately.", "default": false }, "maxItems": { "title": "Max documents", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of documents to convert in this run.", "default": 5 }, "maxPagesPerDocument": { "title": "Max pages per document (0 = all)", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Convert only the first N pages of each PDF / image. 0 converts everything (up to 5,000 pages).", "default": 0 }, "maxRowsPerSheet": { "title": "Max rows per spreadsheet sheet", "minimum": 10, "maximum": 200000, "type": "integer", "description": "Large sheets are cut after this many rows.", "default": 10000 }, "maxFileSizeMb": { "title": "Max file size (MB)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Larger downloads are skipped.", "default": 200 }, "pdfPassword": { "title": "PDF password (optional)", "type": "string", "description": "Used to open password-protected PDFs. Stored encrypted, never logged." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Only used to download your files. The Actor downloads directly first and escalates to Apify datacenter and then residential proxies only if the host blocks it.", "default": { "useApifyProxy": 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 } } } } } } } } } }