REST API Reference
A complete reference of all available REST API endpoints provided by PDFKong. All requests must be prefixed with /v1 and require standard authentication.
/v1/convert
Convert Document
The primary endpoint for converting HTML, Markdown, URLs, or Office Documents into PDFs. This endpoint accepts JSON payloads containing your document source and styling parameters. It also supports idempotency keys to ensure safe retries without double-charging.
/v1/parameters
Get Parameters Schema
Retrieves the complete JSON schema of all supported conversion parameters. This includes their types, validation rules, descriptions, and default values. Useful for dynamically building UI forms or validating payloads on the client side.
/v1/usage
View Usage
Returns your current wallet balance, separating Free and Paid credits. It also provides detailed usage statistics for the current billing cycle, helping you keep track of your API consumption.
/v1/list
List Generated PDFs
Retrieves a paginated list of all PDF documents generated by your account. This is particularly useful for tracking document histories or retrieving lost batch IDs.
/v1/remove/{taskId}
Remove PDF Task
Permanently deletes a specific generated PDF or Batch ZIP archive and its associated metadata from our servers before the standard 24-hour retention period expires. Perfect for strict privacy compliance.
/v1/batch/{batchId}/status
Check Batch Job Status
Polls the real-time processing status of an asynchronous batch generation job using the batch_id returned by the conversion endpoint. Returns progress details and the download URL when completed.
/v1/batch/{batchId}/download
Download Batch ZIP Archive
Downloads the completed ZIP archive containing all generated PDFs for a batch job. This endpoint streams the binary ZIP file and automatically removes the temporary storage archive upon successful transfer.