POST /extraction
Create an extraction. This allows you to specify the fields you would like to extract from which files. Multiple file_ids and field_ids can be specified in a single request. Due to the asynchronous nature of processing extractions, the results for each of these fields will be returned independently. Thus the endpoint will return a number of extraction identifiers (request_id) and the status will be set to “queued” which can then be used to retrieve the results for each extraction.
Headers
Authorization (required) - Requires the standard authentication header used in the system.
Parameters
-
file_ids Body Required
array of file ids to have extraction performed on
-
field_ids Body Required
array of field IDs to be extracted from the document
-
202 AcceptedExtraction has been created successfully.
-
400 Bad RequestMalformed request body, or file_ids/field_ids are missing.
-
403 ForbiddenInvalid or missing authentication token.
-
404 Not FoundEither the file or one or more fields specified do not exist.
-
409 ConflictThe Extract result is not ready.
-
500 Internal Server ErrorSomething went wrong unrelated to the users request.
Response Data
-
file_id
the file identifier for the document being extracted
-
status
the status of the extraction. A successful extraction will return a “complete” value
-
request_id
the id that can be used to return the extractions from the document
{
"file_ids": [
{
"file_id": "<file_id>",
"field_ids": [
"<field_id>",
"<field_id>",
"<field_id>",
"<field_id>",
"<field_id>"
],
"status": "queued",
"request_id": "<request_id>"
}
]
}
Need Help?
Couldn’t find the information you were looking for or need more assistance?
Contact Support