API ReferenceTasks

Check on a running processing task

Check the status of a running processing task.

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.

Path parameters

taskIdstringRequired
ID of task to check.

Headers

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

Query parameters

timeoutintegerOptional
The maximum amount of time in seconds the call should wait before returning the status. If the task reaches a terminal state before timeout elaspes, the status will be returned as soon as it is reached.

Response

Successful.
stateenum

State of the task:

  • setup: This task is still being set up.
  • processing: This task is being processed.
  • failure: Processing on this task ended with a failure.
  • cancelled: This task was cancelled.
  • success: Processing on this task ended successfully. Results will now be available.
completionobjectOptional
Information about number of completed documents. Will be present if the state is 'processing'. May be present in other states, but is not guaranteed.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error