API Polling | pdfRest

Try Now with API Lab

Start right from your browser - upload files, choose parameters, generate code, and send API Calls directly from API Lab!

Request

GET

Headers

Api-Key

Don't have a key? Create an account to get one.

Path Parameters

requestId

Alphanumeric ID (UUID) of the request

Code

curl -X GET "https://api.pdfrest.com/request-status" \ 
  -H "Api-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \

Response

The response for your API Call will display here.

Once you've sent your POST request and received a valid response, you can download your output file using the output URL.

Build Your Solution

You have document processing problems, we have Solutions. Explore the many ways pdfRest can align your documents with your business objectives.

Browse all solutions

Integrate pdfRest with Microsoft Power Automate

Integrate PDF API Tools with Salesforce Apex Code

Control your Backend with pdfRest API Toolkit Self-Hosted

Why pdfRest for API Polling?

pdfRest offers the best solution for polling request statuses, because it prevents timeouts, offers workflow flexibility, and is universally supported across the toolkit.

Avoid Timeouts with Instant Responses

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.

Enhanced Flexibility and Workflow Control

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.

Complete Toolkit Compatibility

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.

Start from Code Examples

See more code examples in our GitHub repository

Need more help?

Start with a Tutorial for step-by-step guidance

How to Poll for API Request Status with cURL

1 item

Customize Your Solution

Learn about the parameters for this tool to create your custom solution.

Request Id

The requestId value is returned in the response from a call sent to any of the pdfRest endpoints when Response-Type: requestId is added as a header parameter with that processing request.

To poll for the status of the request, this value can be used in subsequent calls to the /request-status endpoint by placing it directly in the URL in this format:

https://api.pdfrest.com/request-status/xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Replace the x's with the requestId value.

See Documentation