REST API Reference (v1)4 min read• Updated October 2026
Document Upload Endpoint (POST /v1/upload) (planned, not yet available)
Upload a document file stream and initiate high-speed conversion or extraction.
Overview
PDFparse's public API, SDKs and webhooks are planned and not available yet; the examples below are previews of the intended design. The primary entrypoint for document ingestion. Accepts multipart/form-data with file payloads (upload size depends on your plan).
Parameters & Response Codes
| Parameter / Code | Type | Required | Description |
|---|---|---|---|
| file | Binary / Form | Required | Raw document file payload. |
| tool | string | Required | Tool identifier (e.g. 'pdf-to-excel', 'pdf-to-word', 'compress-pdf'). |
| options | JSON string | Optional | Optional configuration dictionary (e.g. { 'dpi': 300, 'ocrLang': 'eng' }). |
Implementation Snippet
CURL • Production Endpoint
curl -X POST "https://api.pdfparse.dev/v1/upload" \
-H "Authorization: Bearer sk_live_your_key" \
-F "file=@sample.pdf" \
-F "tool=pdf-to-excel"