API endpoints

The Inkit API offers the following endpoints:

Name	Description	URL	SDK Method
Generate Document	Generates a document from a template and a set of merge parameters and stores it in a destination.	`https://api.inkit.com/v1/generate` (POST)	`Render.create()`
Retrieve Document Information	Retrieves information about a generated document.	`https://api.inkit.com/v1/document/{documentId}` (GET)	`Document.get()`
Download Document	Downloads data from a generated PDF document.	`https://api.inkit.com/v1/download/{documentId}` (GET)	`Document.download()`
List Documents	Lists documents and folders created.	`https://api.inkit.com/v1/document` (GET)	`Document.list()`
Delete Document	Deletes a generated document.	`https://api.inkit.com/v1/document/{documentId}` (DELETE)	`Document.delete()`
Generate Document Batch	Generates a batch of documents from a set of merge parameters and destinations.	`https://api.inkit.com/v1/batch` (POST)	`Batch.create()`
Retrieve Batch Information	Retrieves information about a batch of generated documents.	`https://api.inkit.com/v1/batch/{batchId}` (GET)	`Batch.get()`
List Batches	Lists batches created.	`https://api.inkit.com/v1/batch` (GET)	`Batch.list()`
List Folders	Lists private folders in Inkit Storage.	N/A	`Folder.list()`
Create Template	Creates a document template.	N/A	`Template.create()`
Retrieve Template Information	Retrieves information about a document template.	N/A	`Template.get()`
List Templates	Lists document templates.	N/A	`Template.list()`
Retrieve Mail Piece Status	Retrieves information about the delivery status of a Sepire mail piece.	`https://api.inkit.com/v1/mail-piece/{mailPieceId}` (GET)	N/A