Getting started

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.

Parseur API's OpenAPI 3.1 spec is here: https://api.parseur.com/openapi.json

What can you build?

You can:

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

You cannot:

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

Create a key here: https://app.parseur.com/account/api-keys

Add it to the header to every request to https://api.parseur.com, like so:

Replace <YOUR_API_KEY> with your actual key.

See Authentication guide for details.

2) Get your Mailbox ID

If you don't have one yet, create a mailbox in the app (recommended for first-time users) or via API (see Endpoints → Mailboxes → Create a mailbox).

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:

See Upload emails and documents for both methods and examples.

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.

Recommended: Set up a webhook in the app or via the API. See Get data using webhooks guide.

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

See Get data using alternative methods guide

See Retrieve extracted data for all options.

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:

Open an endpoint page and click Try It next to the URL.
Try Parseur API Live

Go to Auth → paste your API key.

Fill Params and/or Body.

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:

LLMs.txt: Use an AI with web access and have it read: https://developer.parseur.com/llms.txt

One-click export: Use the Copy Page dropdown menu at the top of any page to send content directly to ChatGPT or Claude.

MCP for editors: If your code editor supports MCP servers, click the MCP button on any endpoint page for setup instructions.

These methods give AIs the full context they need for accurate integrations.

See Need Help? for details.

Best practices (production)

Use webhooks for delivery; design receivers to be idempotent and respond 2xx within 30s.

Handle errors:

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

Create a mailbox and upload a sample document.

Set a webhook and watch the parsed JSON flow into your app.

Refine your template/AI instructions, then scale confidently.

Welcome aboard — let’s extract some data!

What can you build?#

Quick start in 5 steps#

1) Get your API key#

2) Get your Mailbox ID#

3) Send a document#

4) Get your parsed data back#

5) Verify and iterate#

How to use this documentation#

Main sections#

“Try It” (live calls from your browser)#

Export this documentation#

How can AI use this documentation?#

Best practices (production)#

Next steps#

What can you build?

Quick start in 5 steps

1) Get your API key

2) Get your Mailbox ID

3) Send a document

4) Get your parsed data back

5) Verify and iterate

How to use this documentation

Main sections

“Try It” (live calls from your browser)

Export this documentation

How can AI use this documentation?

Best practices (production)

Next steps