Welcome to the Parseur API! In minutes, you can turn emails and documents into clean, structured data and send it anywhere. This guide shows the fastest path from zero to production and how to use this documentation effectively.What can you build?#
Automate sending documents (files or email-like payloads)
Receive parsed data via webhooks
Toggle/activate/deactivate webhooks programmatically
Programmatically download data (mailbox exports)
Programmatically create mailboxes, set fields/AI instructions, and attach webhooks
View documents, data, and logs
Create/update templates programmatically (use the visual editor in the app)
Manage account/users/billing/subscription (contact us with your use case if you’re on Enterprise plan and require access)
Quick start in 5 steps#
1) Get your API key#
Replace <YOUR_API_KEY> with your actual key.
2) Get your Mailbox ID#
You’ll find the mailbox ID:in your mailbox URL when using the app
in the response from the API when using the API.
3) Send a document#
Use file upload or email/text:4) Get your parsed data back#
Set a webhook on the mailbox so Parseur pushes parsed data as JSON to your endpoint when processing completes. Prefer webhooks over polling; they’re reliable, fast, and production-friendly.Alternatives to webhooks:Automation platforms like Zapier, Make, n8n or Power Automate
Polling: GET /document/{id} (parse the result JSON string)
Download URLs: CSV/JSON/Excel exports at the mailbox level
5) Verify and iterate#
Check document logs and webhook logs in the app. Adjust AI instructions and templates if necessary until the output is perfect.Processing is asynchronous. A successful upload confirms receipt, not that parsing is finished.
How to use this documentation#
Main sections#
Guides: Step-by-step topics (including this page): authentication, sending documents, webhooks, downloads, rate limits, etc.
Endpoints: Every API endpoint with required params, request/response schemas, and code samples in 30+ languages.
Schemas: Shapes for Parser, Document, Webhook, and more. Also includes Partials (sub-objects) and Enums (e.g., DocumentStatusEnum lists the possible document statuses).
“Try It” (live calls from your browser)#
You can call the Parseur API straight from this site:1.
Open an endpoint page and click Try It next to the URL.
2.
Go to Auth → paste your API key.
4.
Click Send and inspect the Response.
Export this documentation#
Use the Export button at the bottom of any page to download as OpenAPI, Markdown, HTML, or Apidog.How can AI use this documentation?#
If you’re using an AI assistant to build your Parseur integration, you have several options to assist you:2.
One-click export: Use the Copy Page dropdown menu at the top of any page to send content directly to ChatGPT or Claude.
3.
MCP for editors: If your code editor supports MCP servers, click the MCP button on any endpoint page for setup instructions.
Best practices (production)#
Use webhooks for delivery; design receivers to be idempotent and respond 2xx within 30s.
403 → check your auth header
429 → you hit a limit; backoff & retry
Respect limits: 5 req/s per IP with a burst of 20. See Rate limits. Your web app tabs count toward your rate limit. If you’re testing the API from the same IP and get limited, close extra tabs.
Use --compressed with cURL to reduce payload sizes.
Use HTTPS, avoid putting secrets in URLs or query strings.
Next steps#
1.
Create a mailbox and upload a sample document.
2.
Set a webhook and watch the parsed JSON flow into your app.
3.
Refine your template/AI instructions, then scale confidently.
