PDF Analysis#

Analyze and extract structured content from PDF files using MinerU. Returns Markdown with layout, headings, and structure preserved.

Install#

bash

npm install -g mineru-open-api
# or via Go (macOS/Linux):
go install github.com/opendatalab/MinerU-Ecosystem/cli/mineru-open-api@latest

Quick Start#

bash

# Quick analysis, no token required (max 10 MB / 20 pages)
mineru-open-api flash-extract report.pdf

# Save to directory
mineru-open-api flash-extract report.pdf -o ./out/

# From URL
mineru-open-api flash-extract https://example.com/report.pdf

# With language hint
mineru-open-api flash-extract report.pdf --language en

# Full analysis with tables and formulas (requires token)
mineru-open-api extract report.pdf -o ./out/

Authentication#

No token needed for flash-extract. Token required for extract:

bash

mineru-open-api auth             # Interactive token setup
export MINERU_TOKEN="your-token" # Or via environment variable

Create token at: https://mineru.net/apiManage/token

Capabilities#

• Supported input: .pdf (local file or URL)
• flash-extract: quick, no token, max 10 MB / 20 pages, Markdown output only
• extract: token required, full features (tables, formulas, OCR, multi-format output)
• Language hint with --language (default: ch, use en for English)
• Page range with --pages (e.g. 1-10)

Notes#

• Use flash-extract for quick reads; use extract for tables, formulas, or files over 10 MB
• Output goes to stdout by default; use -o <dir> to save to a file or directory
• All progress/status messages go to stderr; document content goes to stdout
• MinerU is open-source by OpenDataLab (Shanghai AI Lab): https://github.com/opendatalab/MinerU