> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Airparser

> Airparser extracts structured data from emails, documents, and other files using AI-powered parsing.

![Airparser logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/airparser.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=09c0fac100c3f327cca28a0c8597f5cb)

* **Category:** documents & ocr
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 10
* **Triggers:** 0
* **Slug:** `AIRPARSER`
* **Version:** 20261101\_00

## Tools

> [accordion] Clone Extraction Schema
>
> **Slug:** `AIRPARSER_CLONE_EXTRACTION_SCHEMA`
>
> Replace a destination inbox's extraction schema with a copy of a source inbox's schema.
>
> #### Input Parameters
>
> **source\_inbox\_id** `string` *required*
>
> Inbox whose extraction schema should be copied.
>
> **destination\_inbox\_id** `string` *required*
>
> Inbox whose current extraction schema should be replaced by the copy.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inbox
>
> **Slug:** `AIRPARSER_CREATE_INBOX`
>
> Create an Airparser inbox/parser for a document family using a text or vision extraction engine.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable name for the new inbox.
>
> **llm\_engine** `string ("text" | "vision")`
>
> Parsing engine. Use vision for general documents; use text for small, dense, or tabular text.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Inbox
>
> **Slug:** `AIRPARSER_DELETE_INBOX`
>
> Permanently delete an Airparser inbox and every document it contains. This destructive, cascading operation cannot be undone and requires explicit confirmation.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox ID to permanently delete. Deletion also permanently removes every document contained in the inbox and cannot be undone.
>
> **confirm\_permanent\_deletion** `boolean` *required*
>
> Must be true to confirm permanent deletion of the inbox and all contained documents. This cascading deletion cannot be undone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Usage
>
> **Slug:** `AIRPARSER_GET_ACCOUNT_USAGE`
>
> Return the connected Airparser account's role, verification state, plan, and parsing-credit usage without exposing personal, secret, or internal account fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Document
>
> **Slug:** `AIRPARSER_GET_DOCUMENT`
>
> Get parsed output and status for a document, optionally including extended source and navigation details.
>
> #### Input Parameters
>
> **source** `string ("current" | "parsed")`
>
> For extended detail only, choose current post-processed output or force the original parsed output.
>
> **document\_id** `string` *required*
>
> Document ID returned by parsing or listing documents.
>
> **detail\_level** `string ("compact" | "extended")`
>
> Use compact for normal parsed JSON; extended also returns source text, pages, format, inbox ID, and adjacent document IDs.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inbox
>
> **Slug:** `AIRPARSER_GET_INBOX`
>
> Get one Airparser inbox, including its current extraction schema and useful parsing configuration.
>
> #### Input Parameters
>
> **inbox\_id** `string` *required*
>
> Inbox ID returned by create or list inboxes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Documents
>
> **Slug:** `AIRPARSER_LIST_DOCUMENTS`
>
> List and search documents in one inbox, one page at a time.
>
> #### Input Parameters
>
> **query** `string`
>
> Optional document search text, commonly matched against document names.
>
> **to\_date** `string`
>
> Optional upper date filter; provider inclusivity and timezone semantics are undocumented.
>
> **inbox\_id** `string` *required*
>
> Inbox whose documents should be listed.
>
> **per\_page** `integer`
>
> Maximum documents in this page (1-500).
>
> **from\_date** `string`
>
> Optional inclusive lower date filter; provider timezone semantics are undocumented.
>
> **next\_cursor** `string`
>
> Continuation cursor returned by a previous call; omit for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inboxes
>
> **Slug:** `AIRPARSER_LIST_INBOXES`
>
> List the Airparser inboxes available to the connected account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Parse Document Synchronously
>
> **Slug:** `AIRPARSER_PARSE_DOCUMENT_SYNC`
>
> Upload 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
>
> **file** `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.
>
> **inbox\_id** `string` *required*
>
> Inbox whose extraction schema should parse the document.
>
> **metadata** `object`
>
> Optional JSON metadata copied into parsed output as **meta**.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert Extraction Schema
>
> **Slug:** `AIRPARSER_UPSERT_EXTRACTION_SCHEMA`
>
> Create or completely replace the extraction schema used by an Airparser inbox. The fields array is the complete replacement, not a partial update.
>
> #### Input Parameters
>
> **fields** `array` *required*
>
> Complete replacement schema. Include every scalar, list, object, and enum field that the inbox should extract.
>
> **inbox\_id** `string` *required*
>
> Inbox whose complete extraction schema should be replaced.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
