Skip to main content
Both synchronous and asynchronous extraction endpoints accept the same request body and support the extraction options described below. These options allow you to control:
  • How documents are selected and classified
  • Whether documents are split
  • What additional data is returned
  • How large or complex documents are handled
The file parameter contains the document to be extracted.
  • Required
  • Only one file may be sent per request
  • Files must be Base64-encoded
Supported formats
  • pdf
  • docx
  • txt
  • tiff / tif
  • jpg / jpeg
  • png
Specifies the name of the template created in the UI that should be used for extraction.
  • Required **if **filterNameis not provided
  • Must match the template name exactly, including case and spacing
Templates define the expected structure and fields extracted from a document.
Specifies the name of a filter created in the UI.
  • Required **if **templateNameis not provided
  • Must match the filter name exactly, including case and spacing
Filters automatically determine which template to use based on the rules defined during filter creation.
Enables splitting a single file containing multiple documents into individual documents, which are then extracted separately within the same request.
  • Accepts true or false
  • Defaults to false if not specified
This option is useful for multi-document PDFs such as scanned batches.
Controls whether the extracted documents are returned as Base64-encoded PDF files.
  • Accepts true or false
  • Defaults to false if not specified
This option is commonly used in combination with document splitting when storing the separated PDFs is required.
Controls whether all extracted text is returned as a single text block.
  • Accepts true or false
  • Defaults to false if not specified
This is useful for:
  • Full-text search
  • Indexing
  • Archival or audit purposes
Schema chunking controls how line items are extracted from documents containing repeating or tabular data.
  • Defaults to auto if not specified
Modes
  • Auto
    Extracts line items on a per-page basis, allowing documents to contain a large number of line items.
    Each individual line item must exist entirely within a single page.
  • Combined
    Combines pages during extraction, allowing line items to span multiple pages.
    This mode limits the total number of line items that can be extracted.
Recommendation: Keep schema chunking set to auto unless line items span multiple pages.
Allows extraction of password-protected documents.If the document is password protected, include the password in the request and the system will attempt extraction using the provided password.