API Overview

PSPDFKit Processor has been deprecated and replaced by Document Engine. To migrate to Document Engine and unlock advanced document processing capabilities, refer to our migration guide. Learn more about these enhancements on our blog.

PSPDFKit Processor exposes a single HTTP endpoint for usage:

POST http://localhost:5000/build

This endpoint allows you to declaratively assemble a PDF document from multiple independent parts, applying actions on the whole output file and single parts.

The API expects data to be sent as multipart/form-data, with the only required part being the instructions JSON object:

POST http://localhost:5000/build HTTP/1.1
Content-Type: multipart/form-data; boundary=customboundary
Authorization: Token token=secret

--customboundary
Content-Disposition: form-data; name="instructions"
Content-Type: application/json
{
  "parts": [],
  "actions": []
}
--customboundary--

For more details on the structure of an API request, see the API Reference. To learn more about the authentication mechanism, refer to our authentication guide.