Uploading Documents via the API
While there is a range of different types of API endpoints that drive the Affinda solution, uploading documents for processing (and receiving the response) is core to the product. Without documents, there is no Intelligent Document Processing!
Request Body
The following parameters may be included in the API POST request to Affinda.
Note, all individual parameters are optional, however, one (and only one) of the following must be specified:
- File
- URL
- Data
Parameter | Description |
---|---|
file | File as binary data blob. Supported formats: PDF, DOC, DOCX, TXT, RTF, HTML, PNG, JPG |
url | URL to a document to download and process |
data | A JSON-encoded string of the ResumeData object |
wait | If "true" (default), will return a response only after processing has been completed. If "false", will return an empty data object which can be polled at the GET endpoint until processing is complete. |
identifier | Specify a custom identifier for the document. |
fileName | An optional filename of the file |
expiryTime | The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry. |
language | Language code in ISO 639-1 format. Must specify zh-cn or zh-tw for Chinese. |
Updated almost 2 years ago