DIMARC API - Documentation

⚠️ v2 Migration (breaking changes)

What changes in API responses — extractor, documentalist, token, authentication

🔐 Authentication

Retrieving and using your authentication token

🚀 Agents

Creating, configuring, and deleting your agents through the API

📄 Documents

Ingesting, listing, and deleting a Documentalist agent’s documents

🔍 Documentalist Agent

Communication with your Documentalist agents via the API

📄 Extractor Agent

Extracting structured data from documents

🗂️ Classification

Splitting and classifying a batch of pages by category

🪝 Webhooks

Configure signed webhooks for ingestion and extraction events

⭐ Usage

View your organization’s subscription, quotas, and consumption

📚 Technical Reference

Complete technical specifications of the API

v2 Migration

• Summary of changes
• Extractor
• Documentalist
• Token
• Authentication rejections
• Error codes

Authentication

Tip

All API calls require authentication via token.

• Prerequisites
• Obtaining API keys
• Retrieving the token
• Using the token
• Security best practices
• Troubleshooting

Documentalist Agent

• Description and features
• Prerequisites
• Retrieving an agent’s ID
• Communication with the agent
• Managing history
• Limitations and considerations

Extractor Agent

• Description and features
• Prerequisites
• Retrieving an agent’s ID
• Extraction modes
• Synchronous extraction
• Asynchronous extraction
• Structured data extraction
• Limitations and considerations

Webhooks

• Events
• Event Envelope
• Configuring a Webhook
• Signature Verification
• Retry Policy

Usage

• Retrieve Usage
• period vs current_period_end

Support and Assistance

For any questions regarding the DIMARC API, contact our technical support team at contact@dimarc.fr