Reference

Docmosis: List Templates

Retrieve all available document templates from your Docmosis environment, with optional filtering by folder and pagination. Use this to discover what templates you have available before generating documents.

Download Docmosis Templates

Retrieve and download template files you've created in Docmosis by name, with support for bulk downloads up to 100 templates as a zip file. Use this to access, backup, or share your document templates with team members or clients.

Get Docmosis Template Details

Retrieve detailed metadata about a Docmosis template including its name, file size, modification date, and any processing errors to verify successful uploads and template health.

Get Template Sample Data

Generate sample data that matches your Docmosis template structure, allowing you to test document rendering before using real data. This creates placeholder values in JSON or XML format that automatically align with your template fields.

Docmosis Environment Ready

Checks whether your Docmosis environment is active and has available quota to process document generation requests, preventing failed renders due to service unavailability.

Docmosis Environment Summary

Retrieve real-time information about your Docmosis environment including service status, plan details, and usage quota to monitor your document generation capacity.

Docmosis Ping

Verifies that your Docmosis service is online and accessible so you can ensure document generation will work before attempting to create files.

Docmosis: Delete Image(s)

Remove one or more stored images from your Docmosis account to manage your document template resources and free up storage space. Use this when you no longer need specific images or want to clean up outdated visual assets.

Docmosis: Delete Template(s)

Remove one or more document templates from your Docmosis environment to keep your template library organized and clean. This is useful when templates become outdated or are no longer needed for your document generation workflows.

Docmosis: Get API Key

Retrieves your Docmosis API key from your account connection, which you need to authenticate and use other Docmosis document generation features.

Docmosis: List Images

Retrieve a list of available stock images from your Docmosis library, with optional filtering by folder to quickly find the right visual assets for your documents.

Download Docmosis Images

Retrieve stored image files from your Docmosis account by name, with multiple images automatically packaged into a zip file for easy download.

Get Batch Upload Status

Monitor the progress and completion status of your template batch uploads to Docmosis, helping you know when large batches of templates are ready to use.

Get Docmosis Render Queue

Check the current status and capacity of your document rendering queue to ensure your rendering tasks will be processed without delays. This helps you monitor system utilization and plan your document generation workload accordingly.

Get Docmosis Template Structure

Inspects a Docmosis template to extract its structural elements including form fields, repeating sections, conditional logic, images, and references in JSON format. This helps you understand what data your template expects and how to properly populate it before generating documents.

Get Render Tags

Retrieve statistics on rendered documents organized by user-defined tags, showing monthly breakdowns of page and document counts. This helps you track document generation activity by team, project, or feature.

Ping Docmosis Service

Verify that Docmosis Cloud services are running and available, helping you confirm the service is ready before executing document generation tasks.