What is a pipe?
Think of a pipe as a named project for processing a specific type of document. For example, you might create separate pipes for “Invoice Processing”, “Receipt Scanning”, or “Contract Analysis”.Properties
| Property | Description |
|---|---|
| Name | A descriptive name for the pipe |
| Description | An optional description explaining the pipe’s purpose |
| Email address | An auto-generated email address for receiving documents via email (used with the email trigger) |
| Retention | How long processed files and run data are retained (in days) |
| Status | Active or Paused. Only active pipes accept new files and trigger runs |
Activation
A pipe must be activated before it can process documents. Activation requires a valid pipeline. The pipeline must have at least one trigger, be properly connected, and pass validation. You can deactivate a pipe at any time to stop processing without deleting it.Relationships
- A pipe has exactly one pipeline (the processing workflow)
- A pipe has many files (uploaded documents)
- A pipe has many runs (processing executions)
- Files uploaded to a pipe trigger runs based on the pipeline configuration
Managing pipes
You manage pipes from the Pipes page. You can create, edit, activate, deactivate, and delete pipes.Pipes page
Learn how to manage pipes
Pipelines
Understand the pipeline inside a pipe