PNG/Image to PDF API

Convert an image file to PDF.

Feature

Request Mode

Item	Value
Authentication	x-api-key: your_api_key_here
Request URL	POST http://localhost:8080/api/v1/process/png/pdf
Content type	multipart/form-data
Success response	PDF file stream

Request Parameters

Parameter	Type	Description	Required
file	File	Source file. Recommended extension: .png,.jpg,.jpeg,.bmp.	Yes
options	String	JSON string containing the feature options below.	No
password	String	Source file open password, used for password-protected PDFs.	No

Options Parameters

Put the following fields in the options JSON string.

Parameter	Type	Purpose
sourceType	String or Integer	Source type flag for non-PDF to PDF conversion. The ComPDF Web sends 1.
enableOcr	Integer or String	Whether to use OCR. 0 = disabled, 1 = enabled.
outputFileName	String	Optional output filename. When present, it is used as the preferred download filename.

Request Example

curl -X POST "http://localhost:8080/api/v1/process/png/pdf" \
  -H "x-api-key: your_api_key_here" \
  -F "[email protected]" \
  -F 'options={"sourceType":"1","enableOcr":0}'

Response

On success, the API returns the converted file stream with Content-Type and Content-Disposition headers. On failure, the ComPDF Self-hosted returns a normalized error JSON response.