-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Add documentation for Mindee V2 node #3623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sebastianMindee
wants to merge
3
commits into
n8n-io:main
Choose a base branch
from
sebastianMindee:update-mindee-doc
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 | ||
title: Mindee V2 node documentation | ||
description: Learn how to use the Mindee V2 node in n8n. Follow technical documentation to integrate Mindee node into your workflows. | ||
contentType: [integration, reference] | ||
--- | ||
|
||
# Mindee V2 node | ||
|
||
Use the **Mindee V2** node to analyze **any kind of document** (invoices, receipts, ID cards, contracts, payslips, custom models, …) with Mindee’s V2 “Queues & Polling” API. | ||
Unlike the deprecated V1 node, the V2 node is **model-agnostic**: just specify the *Model ID* you want to run (an off-the-shelf or a custom one) and Mindee returns a structured JSON for every page. | ||
|
||
On this page you will find: | ||
|
||
* Supported operations | ||
* All node parameters | ||
* Links to credentials setup and templates | ||
|
||
/// note | Credentials | ||
Refer to [Mindee V2 credentials](/integrations/builtin/credentials/mindeev2Api.md) for guidance on creating and storing your API key. | ||
/// | ||
|
||
## Operations | ||
|
||
Mindee V2 currently exposes one generic operation: | ||
|
||
| Resource | Operation | Description | | ||
|-----------|---------------------|-----------------------------------------------------------------------------------------------------------------------| | ||
| Inference | **Enqueue and Get** | Upload a document (PDF, image, etc.), run the selected model, poll the server for results, and return the parsed data | | ||
|
||
### Predict | ||
|
||
| Parameter | Description | | ||
|---------------------------|---------------------------------------------------------------------------------------------------------------------------------| | ||
| **Binary Property Name** | Name of the binary field that contains the file (default: `data`). | | ||
| **Model ID** | The identifier of the model to run (*e.g.* `expense_receipts`, `invoice`, `your_custom_model`). | | ||
| **File Alias (optional)** | Friendly filename displayed in Mindee web app. | | ||
sebastianMindee marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| **Enable RAG** | `Enabled` / `Disabled` or `Use Model Default`. Adds Retrieval-Augmented Generation for higher accuracy (supported models only). | | ||
| **Enable Polygons** | Return location polygons for all extracted fields. | | ||
| **Enable Confidence** | Return confidence score for each field. | | ||
| **Enable Raw Text** | Return full raw text of each page. | | ||
sebastianMindee marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| **Polling Timeout (s)** | How long n8n should poll Mindee for results (default 120 s). | | ||
sebastianMindee marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
## How it works | ||
|
||
1. The node builds a `multipart/form-data` request with your file and options. | ||
2. Mindee queues the inference and returns an `enqueue_id`. | ||
3. The node polls `/inferences/{enqueue_id}` until the inference is finished or the timeout is reached. | ||
4. The final structured JSON is returned to your workflow. | ||
|
||
## Example workflow | ||
|
||
1. **HTTP Request** – download a public receipt image. | ||
2. **Mindee V2** – set *Binary Property Name* to `data` and *Model ID* to your desired model. | ||
3. **(optional) Set** – post-process or map the parsed fields. | ||
|
||
Running the workflow returns fields such as `total_amount`, `date`, `supplier_name`, etc., depending on the chosen model. | ||
|
||
## Templates and examples | ||
|
||
[[ templatesWidget(page.title, 'mindeeV2') ]] | ||
|
||
--8<-- "_snippets/integrations/builtin/app-nodes/operation-not-supported.md" | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: Mindee V2 credentials | ||
description: Documentation for Mindee V2 credentials. Use these credentials to authenticate MindeeV2 in n8n, a workflow automation platform. | ||
contentType: [integration, reference] | ||
--- | ||
|
||
# Mindee V2 credentials | ||
|
||
You can use these credentials to authenticate the following nodes: | ||
- [Mindee V2](/integrations/nodes/n8n-nodes-base.mindeev2/) | ||
|
||
## Prerequisites | ||
|
||
Have a [Mindee](https://app.mindee.com/) account. | ||
|
||
## Supported authentication methods | ||
|
||
Mindee V2 uses API key authentication. | ||
|
||
## Related resources | ||
|
||
Refer to the [Mindee documentation](https://docs.mindee.com) for more information. | ||
|
||
## Using an API key | ||
|
||
1. Log in to your [Mindee account](https://app.mindee.com/) | ||
2. Follow the steps in the [Mindee API keys documentation](https://docs.mindee.com/integrations/api-keys) to create and retrieve your API key | ||
3. Copy the API key and paste it into the **API Key** field in n8n |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.