JSON response scheme

 

Each API response follows the same response scheme. The predictions content is specific with the API you use. Once you have subscribed to your preferred API, read the documentation to check for all the outputs available.

 

{
     "call": {
          "endpoint": {
               "name": "endpoint", 
               "version": "2.1"
          },
          "finished_at": "2017-04-11T02:30:49+00:00", 
          "id": "2a81a403-0389-4b39-9b1f-22b5febf795e", 
          "n_documents": 1, 
          "n_inputs": 1, 
          "processing_time": 0.725, 
          "started_at": "2017-04-11T02:30:49+00:00"
     }, 
     "documents": [
          {
               "id": "bf53e6b1-1d29-4187-97ec-bab10eca5744", 
               "name": "filename.png"
          }
          ],
     "predictions": [

          ...

     ]
}

 

call: metadata about the request

 

id: a UUID - this identifies your http call

processing_time: server side processing time in seconds

started_at: datetime for when the call has been received

finished_at: datetime the call has been fully processed

n_documents:  number of documents processed.

n_inputs: number of images and/or pdf pages processed. Your quota will be decreased by this value.

endpoint:

          name: name of the endpoint used to make the call

          version: selected API version

 

 

documents : array with the details of each document sent to the API. NB: a pdf page counts for one document.

id: a UUID - this identifies your document

name: name of file sent, for a pdf this may add the page number at the end

 

predictions: Array with the predictions for each document processed. The structure inside each element of this array is specific with the API you use. NB: for now, each pdf page will output a prediction