{ "openapi": "3.0.1", "info": { "title": "Office Docs to Markdown: DOCX, PPTX, XLSX to Markdown", "description": "Converts Word, PowerPoint and Excel files (by URL or upload) to Markdown and plain text, keeping headings, lists and tables, with one section per slide and one table per sheet.", "version": "0.1", "x-build-id": "fcDdon7orKJTuwrJU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/examsens.ai~office-docs-to-markdown/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-examsens.ai-office-docs-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/examsens.ai~office-docs-to-markdown/runs": { "post": { "operationId": "runs-sync-examsens.ai-office-docs-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/examsens.ai~office-docs-to-markdown/run-sync": { "post": { "operationId": "run-sync-examsens.ai-office-docs-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": { "files": { "title": "Files", "type": "array", "description": "DOCX, PPTX or XLSX files: paste direct links, or upload files. The format is read from the file itself, so a link without a file extension works. When you upload files, also choose the store they went into under \"Store with uploaded files\" so the run may read them." }, "uploadStore": { "title": "Store with uploaded files", "type": "string", "description": "The key value store your uploads went into. The run gets read access to this store only. With no files listed above, every record in it whose key ends in .docx, .pptx or .xlsx is converted." }, "includeSpeakerNotes": { "title": "Include speaker notes", "type": "boolean", "description": "Add each slide's speaker notes after its content.", "default": true }, "imageAltText": { "title": "Keep image alt text", "type": "boolean", "description": "Write [Image: alt text] where a picture with alt text sits. Turn off to leave pictures out entirely. Picture files are never included.", "default": true }, "maxRowsPerSheet": { "title": "Maximum rows per sheet", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Rows of each spreadsheet sheet to write after the first row. Set 0 for no limit.", "default": 1000 }, "includeHiddenSheets": { "title": "Include hidden sheets", "type": "boolean", "description": "Also convert spreadsheet sheets that are hidden.", "default": false }, "maxFileSizeMb": { "title": "Maximum file size (MB)", "minimum": 1, "maximum": 200, "type": "integer", "description": "Larger files are skipped with an error item.", "default": 50 }, "maxConcurrency": { "title": "Files at once", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many files to download and convert in parallel.", "default": 3 } } }, "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 } } } } } } } } } }