DemoFAQ

PDF Generation Template Editor

Open-source visual PDF generation engine with customizable templates and developer-friendly APIs.

View on GitHub

PDF to Markdown API

❖ Feature Description

Convert a PDF file to Markdown.

❖ Request Mode

Sync Request ✓
Process the request inline and return the result file when it completes. Best for small files and immediate feedback.
Async Request
Accept the task first, then use taskId to query status and download the result. Best for large files and batch jobs.

▎Call Flow

1Upload the file
2Call the synchronous endpoint
3Download the result

PDF to Markdown API

POSThttp://localhost:8080/api/v1/process/pdf/markdown

❖ Request Parameters

Authentication credential sent in the header: x-api-key. Sign in to the Dashboard API management page to view the API Access Key for the current deployment.

Body Parameters multipart/form-data

No file selected
Source PDF file. Maximum size: 100 MB.
Conversion options JSON string. See Conversion Options for details.
Source PDF open password. Pass this as a separate form-data field, not inside options.
🔗Request Example
curl --request POST \
  --url http://localhost:8080/api/v1/process/pdf/markdown \
  --header 'x-api-key: YOUR API-KEY' \
  --form [email protected]
✓Response Example
200 OK
Processed successfully. Returns the Markdown result file stream.