Guides

Ingestion Blocks

Suggest Edits

Overview

Ingestion blocks are the entry points of a workflow. They define how documents or data enter the system — whether uploaded manually, sent via email, or ingested through an API.

BlockDescriptionTypical Use Case
File UploadIngest documents via manual upload from the UI.When users manually upload invoices, bank statements, or identity documents for processing.
Email Document UploadIngest attachments from incoming emails automatically.For setups where users or clients forward documents to a dedicated address (e.g., [email protected]).
API IngestionIngest documents and data via REST API calls.For integrations where systems like CRMs, ERPs, or partner platforms send documents automatically.

Configuring Ingestion Blocks

Below are the available configuration options for each ingestion block and their typical usage.

File Upload Block

Configuration Steps:

  1. Upload Method: Drag and drop files directly, or click “Upload” to browse from your system.
  2. Advanced Options: Configure optional pre-processing logic (if applicable).
  3. Testing: Click “Test Block” to validate upload.

Email Document Upload Block

Configuration Steps:

  1. Test Credentials: Enable toggle to use a test email address for test run.
  2. Email Address:
    • Copy the auto-generated test email.
    • Use this address to forward documents for workflow testing.
  3. Advanced Options:
    1. File Filters: Define conditions for which emails to process — for example: 
      Subject should contain "invoice" 
and attachments should be greater than 5kb
    2. Notify on Failure: Enable toggle to receive alerts for failed email ingestion.
    3. Import Email Body: Enable toggle to import email body
  4. Testing: Click “Test Block” to simulate email-based ingestion before publishing.

API Ingestion Block

Configuration Steps:

  1. Test Credentials: Enable test mode for API testing.
  2. Workflow ID: Automatically generated ID to reference this workflow in API calls.
  3. API Key: Required for authenticating requests.
  4. Code Snippets: Copy ready-made examples for multiple SDKs:
    • cURL, Python, Node.js, Ruby, PHP
  5. Testing: Click “Test Block” to confirm connectivity and response format in the output tab.

Best Practices

  • Use File Upload during testing or small-scale manual workflows.
  • Use Email Upload for semi-automated setups or where clients send data frequently.
  • Use API Ingestion for high-volume or system-to-system integrations.
  • Always test ingestion blocks individually before chaining them to extraction or transform blocks.

Updated about 5 hours ago