From 5ec9cc86f3b936a28223c8767e23551fc3165749 Mon Sep 17 00:00:00 2001 From: sebastianMindee <130448732+sebastianMindee@users.noreply.github.com> Date: Thu, 4 Sep 2025 12:18:29 +0200 Subject: [PATCH 1/3] Add documentation for Mindee V2 node --- .../app-nodes/n8n-nodes-base.mindee.md | 7 +- .../app-nodes/n8n-nodes-base.mindeev2.md | 64 +++++++++++++++++++ .../builtin/credentials/mindee.md | 15 ++++- .../builtin/credentials/mindeev2.md | 28 ++++++++ nav.yml | 2 + 5 files changed, 112 insertions(+), 4 deletions(-) create mode 100644 docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md create mode 100644 docs/integrations/builtin/credentials/mindeev2.md diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindee.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindee.md index 9028384c4f5..4f8e18b7501 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindee.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindee.md @@ -1,12 +1,17 @@ --- #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 -title: Mindee node documentation +title: Mindee node documentation (Deprecated) description: Learn how to use the Mindee node in n8n. Follow technical documentation to integrate Mindee node into your workflows. contentType: [integration, reference] --- # Mindee node +/// warning | Deprecated +This page documents the usage for the **Mindee V1 node**, which is now considered **deprecated**. +For new workflows, please use the **[MindeeV2 node](/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md)** instead. +/// + Use the Mindee node to automate work in Mindee, and integrate Mindee with other applications. n8n has built-in support for a wide range of Mindee features, including predicting invoices. On this page, you'll find a list of operations the Mindee node supports and links to more resources. diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md new file mode 100644 index 00000000000..049a028703a --- /dev/null +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md @@ -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. | +| **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. | +| **Polling Timeout (s)** | How long n8n should poll Mindee for results (default 120 s). | + +## 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" + diff --git a/docs/integrations/builtin/credentials/mindee.md b/docs/integrations/builtin/credentials/mindee.md index e8a853f8ea6..3b9eed9f02c 100644 --- a/docs/integrations/builtin/credentials/mindee.md +++ b/docs/integrations/builtin/credentials/mindee.md @@ -1,19 +1,28 @@ --- #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 -title: Mindee credentials +title: Mindee credentials (Legacy) description: Documentation for Mindee credentials. Use these credentials to authenticate Mindee in n8n, a workflow automation platform. contentType: [integration, reference] --- # Mindee credentials +/// warning | Deprecated +This page documents the usage for the **Mindee V1 credentials**, which are now considered **deprecated**. +To use V2 credentials, please use the **[MindeeV2 credentials](/integrations/builtin/credentials/mindeeV2.md)** instead. +/// + You can use these credentials to authenticate the following nodes: -- [Mindee](/integrations/builtin/app-nodes/n8n-nodes-base.mindee.md) +- [MindeeV2](/integrations/builtin/app-nodes/n8n-nodes-base.mindeeV2.md) ## Prerequisites -Create a [Mindee](https://mindee.com) account. +Have a [Mindee](https://platform.mindee.com) account. +/// Note | Legacy accounts +Creation of new legacy accounts is no longer possible. +To create a new Mindee V2 account, head to the [new Mindee interface](https://app.mindee.com). +/// ## Supported authentication methods diff --git a/docs/integrations/builtin/credentials/mindeev2.md b/docs/integrations/builtin/credentials/mindeev2.md new file mode 100644 index 00000000000..e8e67a25efa --- /dev/null +++ b/docs/integrations/builtin/credentials/mindeev2.md @@ -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 diff --git a/nav.yml b/nav.yml index bc55b239ce8..a678b91a8ea 100644 --- a/nav.yml +++ b/nav.yml @@ -441,6 +441,7 @@ nav: - Microsoft Teams: integrations/builtin/app-nodes/n8n-nodes-base.microsoftteams.md - Microsoft To Do: integrations/builtin/app-nodes/n8n-nodes-base.microsofttodo.md - Mindee: integrations/builtin/app-nodes/n8n-nodes-base.mindee.md + - MindeeV2: integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md - MISP: integrations/builtin/app-nodes/n8n-nodes-base.misp.md - Mistral AI: integrations/builtin/app-nodes/n8n-nodes-base.mistralai.md - Mocean: integrations/builtin/app-nodes/n8n-nodes-base.mocean.md @@ -960,6 +961,7 @@ nav: - integrations/builtin/credentials/microsoftsql.md - integrations/builtin/credentials/milvus.md - integrations/builtin/credentials/mindee.md + - integrations/builtin/credentials/mindeev2.md - integrations/builtin/credentials/miro.md - integrations/builtin/credentials/misp.md - integrations/builtin/credentials/mist.md From 6b5b465ce21f67e57f7b43ae5e2ce59e973ec6a0 Mon Sep 17 00:00:00 2001 From: sebastianMindee <130448732+sebastianMindee@users.noreply.github.com> Date: Thu, 4 Sep 2025 12:31:46 +0200 Subject: [PATCH 2/3] fix typos --- docs/integrations/builtin/credentials/mindee.md | 4 ++-- docs/integrations/builtin/credentials/mindeev2.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/integrations/builtin/credentials/mindee.md b/docs/integrations/builtin/credentials/mindee.md index 3b9eed9f02c..4aa66878282 100644 --- a/docs/integrations/builtin/credentials/mindee.md +++ b/docs/integrations/builtin/credentials/mindee.md @@ -9,12 +9,12 @@ contentType: [integration, reference] /// warning | Deprecated This page documents the usage for the **Mindee V1 credentials**, which are now considered **deprecated**. -To use V2 credentials, please use the **[MindeeV2 credentials](/integrations/builtin/credentials/mindeeV2.md)** instead. +To use V2 credentials, please use the **[Mindee V2 credentials](/integrations/builtin/credentials/mindeev2.md)** instead. /// You can use these credentials to authenticate the following nodes: -- [MindeeV2](/integrations/builtin/app-nodes/n8n-nodes-base.mindeeV2.md) +- [Mindee](/integrations/builtin/app-nodes/n8n-nodes-base.mindee.md) ## Prerequisites diff --git a/docs/integrations/builtin/credentials/mindeev2.md b/docs/integrations/builtin/credentials/mindeev2.md index e8e67a25efa..520208de847 100644 --- a/docs/integrations/builtin/credentials/mindeev2.md +++ b/docs/integrations/builtin/credentials/mindeev2.md @@ -7,7 +7,7 @@ contentType: [integration, reference] # Mindee V2 credentials You can use these credentials to authenticate the following nodes: -- [Mindee V2](/integrations/nodes/n8n-nodes-base.mindeeV2/) +- [Mindee V2](/integrations/nodes/n8n-nodes-base.mindeev2/) ## Prerequisites From f48f77e7e241b1a94ad2daad773b30123aca23b2 Mon Sep 17 00:00:00 2001 From: sebastianMindee <130448732+sebastianMindee@users.noreply.github.com> Date: Thu, 4 Sep 2025 14:51:53 +0200 Subject: [PATCH 3/3] apply suggestions --- .../app-nodes/n8n-nodes-base.mindeev2.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md b/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md index 049a028703a..2cde58ff2d0 100644 --- a/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md +++ b/docs/integrations/builtin/app-nodes/n8n-nodes-base.mindeev2.md @@ -24,22 +24,22 @@ Refer to [Mindee V2 credentials](/integrations/builtin/credentials/mindeev2Api.m 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 | +| Resource | Operation | Description | +|-----------|---------------------|----------------------------------------------------------------------------------------------------------------------------| +| Inference | **Enqueue and Get** | Upload a document file (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. | -| **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. | -| **Polling Timeout (s)** | How long n8n should poll Mindee for results (default 120 s). | +| 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)** | An alias for the filename, useful for linking back to your system. | +| **Enable RAG** | Enable Retrieval-Augmented Generation for higher accuracy (supported plans only). | +| **Enable Polygons** | Return location polygons for all extracted fields (supported plans only). | +| **Enable Confidence** | Return confidence score for each field (supported plans only). | +| **Enable Raw Text** | Return full raw text of each page (supported plans only). | +| **Polling Timeout (sec)** | How long n8n should poll Mindee for results (default 120 s). | ## How it works