API ReferenceTasks

Submit files containing documents for processing

Submit files containing documents, starting a task that will process them.

Authentication

Authorizationstring

This API uses our API key HMAC authentication, with empty credential scope.

Access keys and secret access keys will be provided by Emtelligent; contact us for key management. Keys will consist of only printable ASCII characters, and leading and trailing whitespace is insignificant.

OR
x-api-keystring

API keys will be provided by Emtelligent; contact us for key management. Keys will consist of only printable ASCII characters, and leading and trailing whitespace is insignificant.

Headers

AuthorizationstringRequired
Authentication information.
HoststringRequired
Host of server.
X-Auth-DatestringRequired
Date and time of request.

Query parameters

callbackstringOptional

URL to call on task completion (either success or failure). Will be given the task ID as a query parameter ‘id’. Any other information or results must be fetched through other API calls.

featureslist of enumsOptional
List of features to enable, comma separated. If not given, a default set of features will be enabled that depends on the NLP API deployment configuration. This set of features is chosen during NLP API deployment. For the list of default features for your API server please contact Emtelligent.

Response

Accepted, returning task information.
idstring
Unique ID for a task. Use it to check task status or retrieve results.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error