Skip to main content
Airparser logo
  • Category: documents & ocr
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 10
  • Triggers: 0
  • Slug: AIRPARSER
  • Version: 20261101_00

Tools

Slug: AIRPARSER_CLONE_EXTRACTION_SCHEMAReplace a destination inbox’s extraction schema with a copy of a source inbox’s schema.

Input Parameters

string
required
Inbox whose extraction schema should be copied.
string
required
Inbox whose current extraction schema should be replaced by the copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_CREATE_INBOXCreate an Airparser inbox/parser for a document family using a text or vision extraction engine.

Input Parameters

string
required
Human-readable name for the new inbox.
string ("text" | "vision")
Parsing engine. Use vision for general documents; use text for small, dense, or tabular text.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_DELETE_INBOXPermanently delete an Airparser inbox and every document it contains. This destructive, cascading operation cannot be undone and requires explicit confirmation.

Input Parameters

string
required
Inbox ID to permanently delete. Deletion also permanently removes every document contained in the inbox and cannot be undone.
boolean
required
Must be true to confirm permanent deletion of the inbox and all contained documents. This cascading deletion cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_GET_ACCOUNT_USAGEReturn the connected Airparser account’s role, verification state, plan, and parsing-credit usage without exposing personal, secret, or internal account fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_GET_DOCUMENTGet parsed output and status for a document, optionally including extended source and navigation details.

Input Parameters

string ("current" | "parsed")
For extended detail only, choose current post-processed output or force the original parsed output.
string
required
Document ID returned by parsing or listing documents.
string ("compact" | "extended")
Use compact for normal parsed JSON; extended also returns source text, pages, format, inbox ID, and adjacent document IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_GET_INBOXGet one Airparser inbox, including its current extraction schema and useful parsing configuration.

Input Parameters

string
required
Inbox ID returned by create or list inboxes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_LIST_DOCUMENTSList and search documents in one inbox, one page at a time.

Input Parameters

string
Optional document search text, commonly matched against document names.
string
Optional upper date filter; provider inclusivity and timezone semantics are undocumented.
string
required
Inbox whose documents should be listed.
integer
Maximum documents in this page (1-500).
string
Optional inclusive lower date filter; provider timezone semantics are undocumented.
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_LIST_INBOXESList the Airparser inboxes available to the connected account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_PARSE_DOCUMENT_SYNCUpload one document to an inbox and wait for parsing; the response may instead return a document ID with parsing still in progress, and Airparser may generate an extraction schema for an inbox without one. Parsing consumes credits, and retrying an ambiguous failure can create another document and consume more credits.

Input Parameters

object
required
EML, PDF, HTML, TXT, MD, DOCX, XLSX, CSV, JPG, PNG, or BMP file up to 20 MB. ZIP is not supported in synchronous mode.
string
required
Inbox whose extraction schema should parse the document.
object
Optional JSON metadata copied into parsed output as meta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRPARSER_UPSERT_EXTRACTION_SCHEMACreate or completely replace the extraction schema used by an Airparser inbox. The fields array is the complete replacement, not a partial update.

Input Parameters

array
required
Complete replacement schema. Include every scalar, list, object, and enum field that the inbox should extract.
string
required
Inbox whose complete extraction schema should be replaced.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not