GET - Document Results

get

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.

Required scopes

This endpoint requires the following scopes:

• : Provides access to Result Service
• : Read access to documents

Authorizations

OAuth2

OAuth2clientCredentialsRequired

Token URL:

Path parameters

fileIdstringRequired

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

Responses

200

OK

application/json

202

Results are in progress and yet to be finalised.

default

Error

application/json

get

/result/final/{fileId}

cURLRubyPythonNodePHPGo

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 ""

{
  "fileId": "text",
  "status": "text",
  "results": {
    "timestamp": "text",
    "fields": []
  }
}