Documents

The documents API provides functionality for generating PDF documents from prebuilt document templates.

Generate Document

Generates a single PDF document.

Url

https://api.astradoc.io/documents/v1.0/generatedocument

Method

POST

Request Object

Property	Type	Required	Description
templateId	String	Yes	The Id of the document template used to generate the PDF file.
templateVersion	String	No	The version of the template used to generate the PDF file. Defaults to the latest published version. Can be draft or number for specific version.
templateData	String	Yes	A serialized JSON object containing the payload used for template data.

Response Object

Property	Type	Description
Success	Bool	A Boolean indicating whether or not the request was successful.
Message	String	A message containing error information if the request was unsuccessful.
Data	String	A base64 string containing a PDF file.

Generate Documents

Generates a collection of PDF documents.

While this API is capable of generating many PDF documents in a single request, if the number of documents to generate is large and the request takes an extended time to complete, it may be better to rather use the Jobs API to generate documents.

Url

https://api.astradoc.io/documents/v1.0/generatedocuments

Method

POST

Request Object

Property	Type	Required	Description
documents	DocumentData[]	Yes	An array of DocumentData objects containing data for each of the documents being generated.

DocumentData Object

Property	Type	Required	Description
templateId	String	Yes	The Id of the document template used to generate the PDF file.
templateVersion	String	No	The version of the template used to generate the PDF file. Defaults to the latest published version. Can be draft or number for specific version.
templateData	String	Yes	A serialized JSON object containing the payload used for template data.
uniqueIdentifier	String	Yes	A string uniquely identifying this template data set. Used to track the individual PDF documents amongst the results.

Response Object

Property	Type	Description
Success	Bool	A Boolean indicating whether or not the request was successful.
Message	String	A message containing error information if the request was unsuccessful.
Data	DocumentCollectionResult[]	An array of DocumentCollectionResult objects.

DocumentCollectionResult Object

Property	Type	Description
Base64	Bool	A base64 string containing a PDF file.
UniqueIdentifier	String	A string uniquely identifying this result. Will match the uniqueIdentifier string provided in the original request.