API Reference for the asynchronous functions of the AnyParser API
AnyParser
API has asynchronous endpoints for its parsing and extraction features. These are asynchronous endpoints that will return a file ID. You can use this file ID to fetch the results of the extraction at a later time. Consider using if you have longer or more complex files. These async endpoints have a timeout of 180 seconds.
There are 2 async endpoints:
Endpoint | Description |
---|---|
/async/upload | Upload the file to process and the process type. Returns the file ID. |
/async/fetch | Poll the results for a file ID. |
/async/upload
endpoint, get its file_id, and then poll the /async/fetch
endpoint to get the result.
process_type
and get a file ID.
You can specify the following for the process_type
:
process_type | Description |
---|---|
parse | This is the Default. It parses the full content from a file. This has the same functionality as the full-content-parse.parse in the SDK |
parse_with_ocr | It parses the full content from a file with OCR detection and correction. This has the same functionality as the full-content-parse.parse_with_ocr in the SDK |
parse_with_layout | It parses the full content from a file with layout structure analysis. This has the same functionality as the full-content-parse.parse_with_layout in the SDK |
extract_pii | This extracts PII from the document. This has the same functionality as the Extract PII in the SDK |
extract_tables | This extracts tables from the document. This has the same functionality as the Extract Tables in the SDK |
extract_key_value | This extracts key-value pairs from the document. This has the same functionality as the Extract Key-Value in the SDK |
extract_resume_key_value | This extracts the candidate’s information from the resume. This has the same functionality as the Extract Resume Key-Value in the SDK |
file_id
from the /async/upload
endpoint, you then send that file_id
to the /async/fetch
endpoint to retrieve the result.
For more details on how to call this endpoint see the Async Upload Endpoint Example.