The pure client side version of PDF.js Express has a few shortcomings, the main ones not being able to merge annotations into a PDF, and not being able to open and display pre-existing annotations in the document.
To overcome these shortcomings, PDF.js Express offers a set of valuable REST APIs to help perform these actions.
The current features the REST API has are:
It also comes with a utility package to help manage file uploads and authentication.
To use the PDF.js Express Utility API, please head to your profile and enable the API in your dashboard.
You will be provided with 2 license keys, one for the server and one for the client. The client key is domain locked and will only work on the specified domain (and any subdomains), and the server key will work from any server.
You may trial the API with no license key, although the output will be watermarked and usage will be rate limited.
The recommended way to use the APIs is to use the utility package.
If you don't want to use the utility package, you can interact with the REST apis directly:
The pricing for using the REST API is as follows (calculated monthly):
- 0-500 actions: $0 (free)
- Every 5000 actions after: $49 USD
- 50,000+ actions: Contact us
This works out to the following:
- 0-500: $0 USD
- 501-5500: $49 USD
- 5501-10500: $98 USD
- 10501-15500: $147 USD
After 50,000 actions, your API keys will still work, but we will contact you to discuss the next steps in scaling up your application.
Each successful operation counts as one action. Errors do not count as actions.
Developing and testing
See developing for more info.
The files processed are stored in a secure and private way, and can only be accessed by the API using proper authentication. Files are only stored for the purposes of serving this API. After a file is processed/created, it is only accessible via secret URL (with proper authentication) for 3 hours. After 3 hours, the file becomes inaccessible. All files are automatically deleted after ~24hrs.
We also provide a
/delete endpoint to delete processed files after you are done with them if you would like the files to be deleted before the 24 hour mark. The delete endpoint can be used free of charge.