Airparser
API actions for the Airparser integration.
Airparser
Automatically pull key information out of documents with Airparser.
Get parsed document
Get the information Airparser extracted from a specific document.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | Yes | The document to retrieve, given by its ID or URL. |
Response
{
"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.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
inbox_id | string | Yes | The inbox to list documents from. |
from_date | date | No | Only include documents on or after this date. |
to_date | date | No | Only include documents on or before this date. |
status | string | No | Only include documents with these statuses. |
query | string | No | Filter the list of documents returned. |
Response
{
"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.
Response
{
"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.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
inbox_id | string | Yes | The inbox to upload the document to. |
file | string | Yes | The document to upload, given by its URL or uploaded here. |
metadata | object | No | Extra details to attach to the document |
Response
{
"document_id": "doc-abc123",
"status": "success"
}