{
  "openapi": "3.0.1",
  "info": {
    "title": "PDF & DOCX to Markdown for AI and RAG",
    "description": "Document parser: convert PDF, DOCX, HTML and text files into clean Markdown with headings, tables and lists, plus optional RAG chunks. Scanned pages are read with built-in OCR. No external API, Cyrillic and legacy encodings supported.",
    "version": "0.2",
    "x-build-id": "PXGH4cbFoa8wqMBQs"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/praised_tumbler~pdf-docx-to-markdown/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-praised_tumbler-pdf-docx-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/praised_tumbler~pdf-docx-to-markdown/runs": {
      "post": {
        "operationId": "runs-sync-praised_tumbler-pdf-docx-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/praised_tumbler~pdf-docx-to-markdown/run-sync": {
      "post": {
        "operationId": "run-sync-praised_tumbler-pdf-docx-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",
            "maxItems": 100,
            "type": "array",
            "description": "Public http(s) links to PDF, DOCX, HTML or text files. Up to 100 per run. The site's robots.txt is respected.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "inlineDocuments": {
            "title": "Inline documents (base64)",
            "type": "array",
            "description": "Small files passed directly, e.g. [{\"filename\": \"a.pdf\", \"contentBase64\": \"JVBERi0...\"}]. Maximum 20 files and 8 MB in total.",
            "default": []
          },
          "includePages": {
            "title": "Return Markdown per page (PDF)",
            "type": "boolean",
            "description": "Adds a `pages` array with one Markdown string per PDF page.",
            "default": false
          },
          "chunkSizeTokens": {
            "title": "RAG chunk size (tokens)",
            "minimum": 0,
            "maximum": 4000,
            "type": "integer",
            "description": "0 = no chunks. Otherwise adds a `chunks` array with pieces of about this many tokens (estimated), split on headings/paragraphs/sentences, with heading and page references.",
            "default": 0
          },
          "chunkOverlapTokens": {
            "title": "Chunk overlap (tokens)",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Trailing text repeated at the start of the next chunk. Must be smaller than the chunk size.",
            "default": 0
          },
          "removeHeadersFooters": {
            "title": "Remove repeated headers, footers and page numbers",
            "type": "boolean",
            "description": "PDF only. Drops lines that repeat at the top or bottom of most pages (documents with 3+ pages).",
            "default": true
          },
          "maxPagesPerDocument": {
            "title": "Maximum pages per PDF",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Only the first N pages of longer PDFs are converted (and billed).",
            "default": 200
          },
          "maxFileSizeMb": {
            "title": "Maximum file size (MB)",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Larger files are skipped with an error (not billed).",
            "default": 25
          },
          "ocr": {
            "title": "OCR for scanned PDF pages",
            "enum": [
              "auto",
              "off"
            ],
            "type": "string",
            "description": "auto = pages without a text layer (scans) are read with OCR and billed as OCR pages; off = scanned pages are skipped. Pages that have a text layer never use OCR.",
            "default": "auto"
          },
          "ocrLanguages": {
            "title": "OCR language(s)",
            "minItems": 1,
            "maxItems": 3,
            "type": "array",
            "description": "Language(s) of scanned text, up to 3. Choose the real language: Bulgarian text needs 'bul'.",
            "items": {
              "type": "string",
              "enum": [
                "eng",
                "bul",
                "ell",
                "rus",
                "ron",
                "srp",
                "srp_latn",
                "hrv",
                "deu",
                "fra",
                "spa",
                "ita",
                "ukr",
                "mkd"
              ],
              "enumTitles": [
                "English",
                "Bulgarian",
                "Greek",
                "Russian",
                "Romanian",
                "Serbian (Cyrillic)",
                "Serbian (Latin)",
                "Croatian",
                "German",
                "French",
                "Spanish",
                "Italian",
                "Ukrainian",
                "Macedonian"
              ]
            },
            "default": [
              "eng"
            ]
          },
          "maxOcrPagesPerDocument": {
            "title": "Maximum OCR pages per PDF",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Caps how many scanned pages of one PDF are OCR'd (and billed as OCR pages).",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}