Skip to main content

Endpoints

Export SDK provides a single endpoint for generating PDFs. Using the endpoint requires authentication using the X-API-KEY header field—see Authentication for more information.

The latest version of the API is hosted at https://api.exportsdk.com/v1/.

PDF Endpoint#

The pdf endpoint accepts HTTP POST requests, with a JSON body (application/json). It can be accessed here:

POST https://api.exportsdk.com/v1/pdf

Request Body#

The body of your POST request must contain the "templateId" field for the target template and a "data" object that contains the key-value pairs for your template variables.

You can find template ids in the "Templates" section of your dashboard. The JSON structure for your template data can be copied from the "Preview" window in the template editor.

{  "templateId": /* UUID of template to be rendered */,  "data": {    // variables defined in your template and their values  },
  // This optional field (defaults to false) controls whether or not the object stored in  // the request body's data field will be persisted so that it can be referenced later.  // If the data required to render your PDFs contains any sensitive or personally identifiable  // data then we highly recommend you do not persist it.  //  // NOTE: If PDF data is accidentally persisted, it can be permanently deleted by visiting  // the "Debug Console" page of the Export SDK dashboard app.  "debug": false }

Response#

The Content-Type header of the response will have a value of application/pdf and the PDF file binary data will be returned in the response body.