API Polling

Some document processing steps can take time, especially for complex tasks like large file conversions or advanced document optimizations. Waiting for the entire process to complete before receiving a response can lead to timeouts on the front-end or otherwise bog down a synchronous workflow. API Polling solves this by providing immediate control.

When initiating a request to any of the pdfRest endpoints, set the Response-Type header parameter to requestId to enable API Polling and receive an instant response with a requestId. Instead of waiting for the entire process to finish, you can then use the /request-status/ endpoint with the requestId to check its progress at your own pace. This allows you to design a workflow that avoids timeouts and lets you initiate requests without needing to wait for the entire process to complete before proceeding.

API Polling empowers you to design workflows tailored to your specific needs. Imagine building an application that utilizes a series of asynchronous pdfRest tasks. Traditionally, you'd need to wait for each task to complete before continuing to next steps in your workflow. Polling offers greater flexibility!

Initiate all tasks with API Polling enabled, and then use the /request-status/ endpoint to monitor their progress independently. This allows your application to efficiently manage and react to each task's completion individually, rather than being tied to a single, linear workflow.

API Polling seamlessly integrates with all pdfRest tools, offering a unified approach to managing asynchronous tasks. No matter which pdfRest tool you use, simply enable API Polling on your request to receive a requestId. This consistency simplifies development and reduces the need to learn separate methods for handling different asynchronous functionalities.

With API Polling, you can leverage a single approach for all your pdfRest workflows, streamlining development and promoting code reusability.