Documentation

API Endpoint

The endpoint synchronously generates a PDF document and returns it directly as the HTTP response.

POST http://{servername}:8080/pdfguard/api/v1/render
Content-Type: application/json

Request Parameters

All parameters are sent as JSON in the request body.

Templates

PDF templates define the visual layout and structure of generated documents. A customer environment may contain one or multiple templates.

The template to be used can be selected via the optional template field in the request body. If the field is omitted, the default template is applied.

{
  "template": "default"
}

Custom template example

Below is an example of a customer-specific template. Custom templates may include complex layouts such as table-based documents, invoices, certificates, reports or government forms.

Code Examples

import java.io.InputStream;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.charset.StandardCharsets;

public class Example {

  public static void main(String[] args) throws Exception {

    String json =
      "{"
    + "\"template\":\"default\","
    + "\"title\":\"Damage Report\","
    + "\"subtitle\":\"Date: 2026-01-10\","
    + "\"fields\":["
    + "  {\"label\":\"Name\",\"value\":\"John Doe\"},"
    + "  {\"label\":\"Email\",\"value\":\"john@example.com\"},"
    + "  {\"label\":\"Damage Type\",\"value\":\"Water damage\"}"
    + "],"
    + "\"footer\":\"Generated with OnPremPDF\""
    + "}";

    URL url = new URL("https://sandbox.onprempdf.com/pdfguard/api/v1/render");
    HttpURLConnection con = (HttpURLConnection) url.openConnection();

    con.setRequestMethod("POST");
    con.setRequestProperty("Content-Type", "application/json");
    con.setDoOutput(true);

    try (OutputStream os = con.getOutputStream()) {
      os.write(json.getBytes(StandardCharsets.UTF_8));
    }

    int status = con.getResponseCode();
    System.out.println("HTTP Status: " + status);

    if (status != 200) {
    throw new RuntimeException("HTTP error: " + status);
    }

    try (InputStream is = con.getInputStream()) {
      Files.copy(is, Path.of("document.pdf"), java.nio.file.StandardCopyOption.REPLACE_EXISTING);
    }

    System.out.println("PDF generated successfully.");
  }

}

import requests

payload = {
  "template": "default",
  "title": "Damage Report",
  "subtitle": "Date: 2026-01-10",
  "fields": [
    { "label": "Name", "value": "John Doe" },
    { "label": "Email", "value": "john@example.com" },
    { "label": "Damage Type", "value": "Water damage" }
  ],
  "footer": "Generated with OnPremPDF"
}

r = requests.post(
  "https://sandbox.onprempdf.com/pdfguard/api/v1/render",
  json=payload
)

r.raise_for_status()

with open("document.pdf", "wb") as f:
  f.write(r.content)

$payload = @{
  template = "default"
  title = "Damage Report"
  subtitle = "Date: 2026-01-10"
  fields = @(
    @{ label = "Name"; value = "John Doe" }
    @{ label = "Email"; value = "john@example.com" }
    @{ label = "Damage Type"; value = "Water damage" }
  )
  footer = "Generated with OnPremPDF"
} | ConvertTo-Json -Depth 5

Invoke-RestMethod `
  -Uri "https://sandbox.onprempdf.com/pdfguard/api/v1/render" `
  -Method POST `
  -ContentType "application/json" `
  -Body $payload `
  -OutFile "document.pdf"

curl -X POST https://sandbox.onprempdf.com/pdfguard/api/v1/render \
  -H "Content-Type: application/json" \
  -d '{
    "template": "default",
    "title": "Damage Report",
    "subtitle": "Date: 2026-01-10",
    "fields": [
      { "label": "Name", "value": "John Doe" },
      { "label": "Email", "value": "john@example.com" },
      { "label": "Damage Type", "value": "Water damage" }
    ],
    "footer": "Generated with OnPremPDF"
  }' \
  --output document.pdf

const payload = {
  template: "default",
  title: "Damage Report",
  subtitle: "Date: 2026-01-10",
  fields: [
    { label: "Name", value: "John Doe" },
    { label: "Email", value: "john@example.com" },
    { label: "Damage Type", value: "Water damage" }
  ],
  footer: "Generated with OnPremPDF"
};

fetch("https://sandbox.onprempdf.com/pdfguard/api/v1/render", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload)
})
.then(res => {
  if (!res.ok) throw new Error("HTTP error " + res.status);
  return res.blob();
})
.then(blob => {
  window.open(URL.createObjectURL(blob));
})
.catch(err => console.error(err));

Audit Retention

Defines how long audit logs are retained before automatic deletion.

• Supports GDPR compliance
• Prevents unlimited log storage
• Automatic cleanup of older audit entries