PDF.co Request Tester is a useful and easy-to-use tool that can help you get started in API testing. Using this tool, you may quickly call any of the PDF.co Web API endpoints to perform a task and see its output all in one place.

PDF.co Request Tester Benefits?

Ease of Use

The PDF.co Request Tester is easy to navigate and use. It has a quick endpoint selection dropdown box to easily switch between endpoints and load their corresponding samples.

Built-in Testing Tool

The Request Tester is one of PDF.co’s powerful built-in testing tools that comes in handy for quick file and configuration testing.

Quick Output Preview

The PDF.co Request Tester supports quick file preview within the tool. It’s a very convenient way to get a glimpse of the file output.

Direct Download Option

Aside from generating the output file URL, the PDF.co Request Tester also supports the direct download option. This will store the file on your local machine without leaving the tool.

Local File Upload

The PDF.co Request Tester supports both local file upload and URLs as source files. It eliminates the step to upload your file in the cloud and keeps your file private.

Ready-to-use Samples

Each endpoint comes with its own ready-to-use samples. The default parameters can easily be changed with your own configuration and the sample source file can be overridden without removing the sample file URL.

Access to Advanced Features

This enhanced PDF.co testing tool now supports custom configuration use. The profiles parameter can now be modified which includes setting custom file filters, OCR Mode, and more.

 

GO TO REQUEST TESTER

PDF.co Request Tester Parameters

  • url to the source file is a required parameter. The links from Google Drive, Dropbox, and from built-in PDF.co files storage are supported. If you need to upload files using API, just go to Files Upload section. If you happen to get the following errors for your input URL – Too Many Requests or Access Denied, please, try to add cache: . This will enable built-in URL caching.
  • httpusername is an optional parameter if you need to access the source url.
  • httppassword is an optional parameter if you need to access the source url.
  • templateId is a required parameter to set the Document Parser template ID that will be used. You can view and manage your existing templates at https://app.pdf.co/document-parser
  • template is an optional parameter. You can use the Document Parser template code directly.
  • inline is an optional parameter. If it is set to true the results will be returned inside the response. Otherwise, the endpoint will return a link to the generated output file.
  • outputFormat is an optional parameter. The default output format is JSON. You can override this format to CSV or XML if you need to get CSV or XML output accordingly.
  • password is an optional parameter. This refers to the PDF file password as a String.
  • async is an optional parameter. The processing is run asynchronously and returns Use JobId that may be used with /job/check to check the processing state (here are some possible states: working, failed, aborted and success). Must be one of: true, false.
  • encrypt is an optional parameter. It enables output file encryption. Must be one of: true, false.
  • name is an optional parameter. It refers to the File name of the generated output that must be a String.
  • expiration is an optional parameter. It refers to the output link expiration in minutes. The default parameter is set to 60. When this time is reached, the generated output file(s) will be auto-removed from PDF.co temporary files storage. The maximum expiration period depends on your current subscription plan. To store the input files permanently (for example, images, PDF, documents for re-use), please go to PDF.co built-in Files Storage.
  • profiles is an optional parameter. Must be a String. The additional options can be set via this parameter allowing custom configuration usage. See profiles samples for examples.

Request Tester Tool Demo

Request Tester Tool Demo
Request Tester Tool Demo

How to Use PDF.co Request Tester

You can access the PDF.co Request Tester in your PDF.co dashboard. Here’s the direct link to log in https://app.pdf.co/request-tester

Step 1 – To begin, let’s select the PDF.co API endpoint that we want to use. Kindly click on the API endpoint drop-down box and choose the /pdf/edit/add.

Select PDF.co API Endpoint

Step 2 – There are 2 ways that you can add your file in the Request Tester. If your file is available in the cloud, you can add the file URL in the Input parameter URL field. If your file is stored in your local machine, simply click on the Choose File button to open the file. If you don’t have access to your file and just want to quickly test the endpoint, you can use our sample file URL.

Choose Local File Or File URL

Step 3 – Once your set, click on the Run Request button.

Run Request

Step 4 – To see what the output looks like, kindly click on the preview link. There’s also a direct download link option to get a copy of the output.

View Output Options

Step 5 – Here’s the output preview.

Output Preview

Step 6 – To learn more about the API endpoint, you can expand its description. It contains information about what the API can do, its parameters and their corresponding functions, and some of our recommended tools and quick tips to maximize your PDF.co API use.

View API Description