Templafy Public API FAQs

General documentation for the Templafy Public API is found here:
https://api.templafy.com/

By default, this link will open the latest stable version of the API, but different definitions or versions can be seen by choosing from the definition dropdown at the top of the page:

In the API version dropdown menu mentioned in the question above, there are some versions labeled as preview or unstable.

Templafy has three API stages:

1. Unstable - this stage is in active development. It is subject to changes at any time without warning and should not be used.
2. Preview - this stage can be used for the purpose of testing and giving early feedback. It should not be used in any production process since it is still subject to breaking changes. 
3. Stable - after sufficient feedback and testing of an API version, it graduates to Stable status. Stable versions can be used in production processes. These versions can be identified in the documentation as versions with simple version numbers (for example, v2) without a preview or unstable label. These versions will remain active for a long period of time, and any deprecation of these versions will be announced in advance.
   

   Important Use only Stable API versions in production.

Templafy does have two sets of technical limits for use of the public API. These limits are:

• 500 calls per 10 seconds
• 30,000 calls per 1 hours

The Templafy API uses API keys to authenticate and identify the calling program or user. 

API keys can be created, regenerated, modified, and revoked directly in the Templafy Admin Center. For more information about API Keys in Templafy, refer to this article: API Keys.

Maintain Template and Asset Libraries:

• GET method available for:
  • Spaces - used to get a full list of spaces and their corresponding Space Ids.
  • Libraries - used to get a full list of Libraries and Space Ids or basic information about a specific Library.
• GET, POST, PATCH, DELETE methods available for:
  
  • Documents
  • Presentations
  • Spreadsheets
  • Email Elements
  • Text Elements
  • Slides
  • Slide Elements
  • PDFs
  • Images
  • Links
  • Folders

Create and Maintain Templafy Data Sources:

• GET, POST, PATCH, DELETE methods available for:
  
  • Data Sources - the "table"
  • Data Source Fields - the column fields of the "table"
  • Data Source Items - the data rows in the "table"
• PUT and DELETE methods available for
  
  • Data Source Item Fields - single field value in a data row

Unattended Document Generation:

More information for how to use the Templafy API to generate documents can be found here: Unattended Document Generation Using the Templafy API.

• POST method available for:
  • Documents
  • Presentations
  • Spreadsheets
  • Text Elements