API - Interact with Docmiral Programmatically

Docmiral provides a powerful RESTful API that allows developers to interact with the platform programmatically. With the API, you can create and manage templates, entities, mini apps, and more, enabling seamless integration with your existing workflows and applications.

Getting Started

To get started with the Docmiral API, you'll need to generate an API token from your account settings. This token will be used to authenticate your requests to the API endpoints.

Key Endpoints

• Templates: Create, retrieve, update, and delete templates. You can also fetch template schemas and preview templates.
  Documentation for Templates
• Entities: Manage entities created from templates. This includes creating new entities, retrieving existing ones, and generating PDFs.
  Documentation for Entities
• Buckets: Handle data storage for mini apps. You can create and manage buckets to store dynamic data.
  Documentation for Buckets
• Mini Apps: Interact with mini apps by creating, updating, and retrieving them via the API.
  Documentation for Mini Apps

Authentication

All API requests must include the API token in the Authorization header. For example:

Authorization: Bearer YOUR_API_TOKEN

Rate Limits

To ensure fair usage, the Docmiral API enforces rate limits on requests. Please refer to the API documentation for specific details on rate limits and how to handle them.

Support

If you have any questions or need assistance with the Docmiral API, please visit our Support Page or contact our support team at support@docmiral.com.

Start leveraging the power of Docmiral's API to automate your document workflows and integrate with your existing systems today!