GET - Document Results

This endpoint allows you to query the results gathered from Sypht's field extraction.

Refer to AI Products for detailed description of fields extracted for each AI product.

GET/result/final/{fileId}

Authorization

OAuth2

Path parameters

fileId*string

The unique identifier associated to the document received at the time of upload.

Response

200202default

OK

Body

application/json

statusstring

Result retrieval status (IN PROGRESS or FINALISED)

fileIdstring

The unique identifier associated to the document received at time of upload.

timestampstring

resultsarray of Sources (array of object)

A list of all the fields extracted from the document along with the name, value and confidence (range 0-1, where 1 implies 100%).

Request

curl --location --request GET "https://api.sypht.com/result/final/{{file id}}" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer {{access token}}" \
  --data ""

Response

{
  "status": "text",
  "fileId": "text",
  "timestamp": "text",
  "results": [
    [
      {
        "source": "text",
        "timestamp": "text",
        "fields": [
          {
            "name": "text",
            "value": "text",
            "confidence": "text"
          }
        ]
      }
    ]
  ]
}