# Mindee

Category: Platforms
|
Runtime: 0.5
|
Available: Free

# Overview

Mindee node connects with Mindee (opens new window) platform for OCR based document scanning. Mindee is a powerful OCR software platform that does the document processing using computer vision and machine learning.

# Setup

# Prerequisites

For Mindee node to work properly, you need to have a valid subscription of Mindee account (opens new window). Ensure to have the API key from the Mindee portal for the node to connect with the platform and process the document.

# Installation

To install the node from designer:

  1. Go to Add more nodes option on the palette section.
  2. Check for the Mindee node and click install.
  3. Once installed, the designer is required to be restarted.

To install the node from CLI:

  1. Go to your project workspace where you can see your package.json file.
  2. Run the below give npm command.
    npm i @kumologica/kumologica-contrib-mindee

# Technical Details

Properties

  • Document Type (Optional)
    The node support invoice, receipts and passport as the document type.
  • API Key (Required)
    Token for authenticating the node with Mindee platform. API key is generated from the Mindee platform by selecting appropriate document type.
  • File stream (Required)
    File content as a buffer to send for scanning.
  • File Name (Optional)
    Name of the file send for scanning.

Supported Operations

Invoice Receipt Passport

Throws

  • MindeeError

Returns

Payload will be overwritten by this node. None of the variables will be overwritten or enriched by this node. Response from the node can be accessed using msg.payload.

← Transcribe →