PDF Template API

File to be converted. Value can be URL or file content.

Property Fields example:

JSON object containing values to be inserted into the document's custom properties fields.

[
  {
    "Name": "ProductName",
    "Value": "Acme Product",
    "Type": "string"
  },
  {
    "Name": "Price",
    "Value": "99.50 USD",
    "Type": "string"
  },
  {
    "Name": "Quantity",
    "Value": 10,
    "Type": "integer"
  },
  {
    "Name": "OrderDate",
    "Value": "2011-11-11",
    "Type": "datetime"
  },
  {
    "Name": "Paid",
    "Value": true,
    "Type": "boolean"
  }
]

Placeholders example:

JSON object containing values to be inserted into the document's placeholders.

[
  {
    "Name": "name",
    "Value": "John",
    "Type": "string"
  },
  {
    "Name": "myImage",
    "ImageWidth": 200,
    "imageHeight": 100,
    "Value": "/9j/4AAQS...<Rest_of_image_base64_string>",
    "Type": "image",
    "Link": "https://www.convertapi.com/"
  },
  {
    "Name": "myCustomTable",
    "Type": "table",
    "TableData": [
      ["Row1Cell1", "Row1Cell2", "Row1Cell3"],
      ["Row2Cell1", "Row2Cell2", ""]
    ]
  },
  {
    "Name": "myHtml",
    "Value": "<h2 style=\"color:green\">Hello <i>World!</i></h2><p>Another paragraph <b>here</b>.</p>",
    "Type": "html",
    "Link": "https://www.example.com"
  },
  {
    "Name": "MyCondition",
    "Value": "false",
    "Type": "conditional"
  }
]

Choose the binding method. Select whether the converter should fill data from Word document properties fields or search for placeholders within the text.

When the StoreFile parameter is set to True, your converted file is written to ConvertAPI’s encrypted, temporary storage and made available via a time-limited secure download URL, valid for up to 3 hours. After this period, the file is permanently deleted.

When StoreFile is set to False, conversion happens entirely in-memory. The raw file bytes are streamed back in the API response without touching disk or external storage, ensuring maximum security and zero persistence so that only you can access the content.