Developer documentation

Use Docly through the web UI or automate it through the API

The web flow is optimized for human uploads. The API flow adds stable auth, monthly quota control, async jobs, and dependency-aware behavior for agents and products.

Quick start

Pick a tool, upload your file, and process it directly in the browser. Free plan limits apply automatically unless a valid Pro key is present.

API auth

Send X-API-KEY or a bearer token to /api/v1 endpoints. Async mode is available for heavy operations through ?async=1.

Health + ops

Use /healthz for liveness and /api/health/dependencies for DB, Stirling, and Redis status before high-volume runs.

Key reference surfaces

Recommended workflow guides

Workflow guide

How to build a privacy-first PDF workflow for sensitive files

Build a privacy-first PDF workflow with redaction, metadata cleanup, OCR checks, and temporary processing best practices.

Workflow guide

Why PDF to Markdown is a better ingestion format for RAG and agent workflows

Use PDF to Markdown for RAG, agent context windows, and cleaner long-document ingestion with fewer formatting artifacts.

Workflow guide

How to turn a scanned PDF into a searchable PDF without breaking the workflow

Convert scanned PDFs into searchable documents with OCR, then validate text quality before downstream editing or indexing.