Airparser
App · Document Extraction · 4 actions · 1 trigger
Automatically pull key information out of documents with Airparser.
Triggers
Start a workflow when something happens in Airparser. See how triggers work.
Airparser New Document
Triggers when a new document is parsed in an Airparser inbox
Filters
Narrow which events start a run.
inbox_idRequired
Event fields
What a run starts with. Later steps read each field with an @ reference.
_idtextstatustextcreated_attextjsonobjectdata_texttext
Actions
| Action | What it does |
|---|---|
| Get parsed document | Get the information Airparser extracted from a specific document. |
| List documents | List documents in an Airparser inbox. |
| List inboxes | List all inboxes in the Airparser account. |
| Upload document | Upload a document to an Airparser inbox for parsing. |
Get parsed document
Get the information Airparser extracted from a specific document.
Inputs
- Document
document_idtextRequired - The document to retrieve, given by its ID or URL.
Outputs
documentobjectstatustext
Example output
{
"document": {
"_id": "doc-001",
"json": {
"date": "2024-01-15",
"invoice_number": "INV-2024-001",
"total": 1234.56
},
"status": "parsed"
},
"status": "success"
}List documents
List documents in an Airparser inbox.
Inputs
- Inbox
inbox_idtextRequired - The inbox to list documents from.
- After This Date
from_datedate - Only include documents on or after this date.
- Before This Date
to_datedate - Only include documents on or before this date.
- Status
statustext - Only include documents with these statuses.One or more of:
new,importing,parsing,parsed,fail(Failed),quota(Quota Exceeded),exception. - Query Filters
querytext - Filter the list of documents returned.
Outputs
documentsliststatustext
Example output
{
"documents": [
{
"_id": "doc-001",
"created_at": "2024-01-15T10:00:00Z",
"status": "parsed"
},
{
"_id": "doc-002",
"created_at": "2024-01-16T11:00:00Z",
"status": "parsed"
}
],
"status": "success"
}List inboxes
List all inboxes in the Airparser account.
Inputs
None.
Outputs
inboxesliststatustext
Example output
{
"inboxes": [
{
"_id": "inbox-001",
"email": "invoices@inbox.airparser.com",
"name": "Invoices"
},
{
"_id": "inbox-002",
"email": "receipts@inbox.airparser.com",
"name": "Receipts"
}
],
"status": "success"
}Upload document
Upload a document to an Airparser inbox for parsing.
Inputs
- Inbox
inbox_idtextRequired - The inbox to upload the document to.
- File
filetextRequired - The document to upload, given by its URL or uploaded here.
- Metadata
metadataobject - Extra details to attach to the document
Outputs
document_idtextstatustext
Example output
{
"document_id": "doc-abc123",
"status": "success"
}