Conversion API Reference

Reference for ComPDF Self-hosted conversion APIs.

Conversion APIs are grouped as PDF to other formats, other formats to PDF, and image to other formats. All conversion APIs require the x-api-key request header.

Feature	Request URL
PDF to Word API	/api/v1/process/pdf/docx
PDF to Excel API	/api/v1/process/pdf/xlsx
PDF to PowerPoint API	/api/v1/process/pdf/pptx
PDF to HTML API	/api/v1/process/pdf/html
PDF to RTF API	/api/v1/process/pdf/rtf
PDF to Image API	/api/v1/process/pdf/png
PDF to CSV API	/api/v1/process/pdf/csv
PDF to TXT API	/api/v1/process/pdf/txt
PDF to JSON API	/api/v1/process/pdf/json
PDF to OFD API	/api/v1/process/pdf/ofd
PDF to Searchable PDF API	/api/v1/process/pdf/pdf
Word to PDF API	/api/v1/process/docx/pdf
Excel to PDF API	/api/v1/process/xlsx/pdf
PowerPoint to PDF API	/api/v1/process/pptx/pdf
HTML to PDF API	/api/v1/process/html/pdf
TXT to PDF API	/api/v1/process/txt/pdf
CSV to PDF API	/api/v1/process/csv/pdf
RTF to PDF API	/api/v1/process/rtf/pdf
PNG/Image to PDF API	/api/v1/process/png/pdf
Image to Word API	/api/v1/process/img/docx
Image to Excel API	/api/v1/process/img/xlsx
Image to PowerPoint API	/api/v1/process/img/pptx
Image to JSON API	/api/v1/process/img/json
Image to TXT API	/api/v1/process/img/txt
Image to HTML API	/api/v1/process/img/html
Image to RTF API	/api/v1/process/img/rtf
Image to CSV API	/api/v1/process/img/csv

Common Rules

Item	Description
Authentication	Request header: x-api-key: your_api_key_here.
Content type	multipart/form-data.
Result	Successful requests return a file stream directly.
Parameters	options is a JSON string; password is a separate form-data field.

Request Example

curl -X POST "http://localhost:8080/api/v1/process/pdf/docx" \
  -H "x-api-key: your_api_key_here" \
  -F "file=@/path/to/sample.pdf" \
  -F 'options={"pageRanges":"1-3","enableOcr":"0"}'