Skip to main content

API Overview

The DynamicPDF API provides numerous APIs you can use to integrate PDF capabilities into your applications. Use the REST endpoints directly or use one of the provided client libraries.

The DynamicPDF API has six endpoints for working with PDFs. All six endpoints take a POST request. While the image-info, pdf-info, pdf-text, pdf-xmp, and dlex-layout endpoints are straightforward and perform a single function; the pdf endpoint is more complex and allows a variety of processing tasks to create a PDF. Unlike the other five endpoints, the pdf endpoint takes a JSON instructions document which allows fine-grained control over how you generate a finished PDF.


A good starting point for understanding the DynamicPDF API is by reviewing the processing steps for calling an endpoint (Endpoint Workflow).

The following sections list the REST endpoints and available client libraries. It also lists the endpoints region you can use when calling the REST endpoints. If the region is left to the default, then DynamicPDF attempts to select the closest region for your organization.


DynamicPDF has different endpoint regions that you can use when calling one of the endpoints.

REST Endpoints

dlex-layoutAPI Users Guide - dlex-layoutReturns a PDF after processing a DLEX file with it's associated JSON data.
image-infoAPI Users Guide - image-infoReturns image metadata as a JSON document.
pdf-imageAPI Users Guide - pdf-imageConverts a PDF to an image and returns as an image or JSON.
pdf-infoAPI Users Guide - pdf-InfoReturns PDF metadata as a JSON document.
pdf-textAPI Users Guide - pdf-textReturns the text from a PDF as a JSON document.
pdf-xmpAPI Users Guide - pdf-xmpReturns XMP metadata from a PDF.
pdfAPI Users Guide - pdfReturns a PDF after performing one of the pdf endpoint's tasks (page, dlex, html, word, image) or merging.

Run In Postman

Client Libraries

The DynamicPDF API provides client libraries implemented in the following languages.

  • C#
  • Go
  • Java
  • Node.js
  • PHP
  • Python

More languages are coming, such as Ruby.


Access the libraries from the DynamicPDF API github project at The client library for each respective language is also available for incorporation into your project via Nuget, Maven, npm, PIP, or Composer.

APIGitHub LocationAPI DocumentationLibrary
Java Client API DocumentationMaven: Groovy etc:

Refer to each client library's file on github for documentation on the library.

Endpoint Zones

The DynamicPDF API REST endpoints are deployed on 10 API zones, You should use the default endpoint at since it automatically routes to the closest zone. However, if you wish to target a specific zone, then you can any of the following specific API zones.

RegionAPI Zone
East USA
West USA
Brazil South
Western Europe
South Africa North
UAE North
Central India
Southeast Asia
Japan East
Australia East


Every API endpoint request must have an Authorization header that specifies the API key used in securing the endpoint call. You obtain this key from the Apps Manager and a request header has the following format, where "DP.V9xxxxx" is the API key.

Authorization: Bearer

Example Header

curl -X POST "" 
-H "accept: application/json"
-H "Authorization: Bearer"
-H "Content-Type: application/pdf"
--data-binary "@c:/holding/pdf-xmp/fw4.pdf"

Do not assume the example header is implying that the endpoint only accepts a file. Realize the --data-binary sent to the endpoint is a byte-array.

For more information on API keys, refer to Apps Manager in the Users Guide (Apps Manager).

   Follow us on social media for latest news!