Skip to main content

Basics

Parser​

A Parser is a customized workflow created for each client to extract specific data fields from an image or PDF. This allows for tailored field extraction based on document type and use case.

Parser App​

Each parser is associated with a unique identifier, referred to as the Parser App.

Hit the API​

  • Refer to the documentation to understand how to structure your request.
  • Use the file key to upload a valid file format (e.g., PDF, JPEG, PNG, TIFF).
  • The parser and api keys are customizable based on client credentials.

Extra Accuracy​

  • This option can be toggled on or off.
  • When enabled, it improves performance on handwritten or scanned documents.
  • Note: Enabling this increases the cost per API call.

File​

The document to be parsed. Supported formats include:

  • PDF
  • JPEG
  • PNG
  • TIFF

Response​

Expected Response​

  • The expected response is in JSON format.
  • The structure and fields of the JSON will vary depending on the specific parser used.

Total Attempts​

  • Represents the number of times the API attempts to process the request.
  • Useful in retry mechanisms if initial attempts fail.

Job Status​

Status of the API processing job. Possible values include:

  • success
  • failed
  • accepted
  • processing

Credits Consumed​

Indicates the amount of API usage billed to the user for the job.

Total Pages​

Number of pages in the uploaded file.

File URL​

A direct link (typically to an S3 bucket) where the uploaded file is stored.

Job ID​

A unique identifier assigned to each API job for tracking and logging purposes.