LogoLogo
Sypht AppHelp CenterMarketplace
  • Introduction
  • Setup
    • Authentication
  • Upload and Extract
    • Upload and Extract (v2)
    • Upload and Extract (v1)
    • File management
  • Workflows (v1)
    • Real-time validation
    • Smart document split
    • Entity matching
  • Workflows (v2)
    • extraction (sypht.extract)
    • Real-time validation (sypht.validate)
    • Smart document split (sypht.split)
  • Field types
    • Line Items
    • Classification fields
    • Signals
    • Values
  • API Docs
    • API Introduction
    • Authentication
      • POST - Authentication Token
    • Upload Document
      • POST - Upload Document
      • POST - Upload JSON
    • Results
      • GET - Document Results
      • GET - Image Results
    • Upload Annotation
      • PUT - Upload Annotation
Powered by GitBook
On this page

Was this helpful?

  1. API Docs
  2. Results

GET - Document Results

PreviousResultsNextGET - Image Results

Last updated 3 years ago

Was this helpful?

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.

Authorizations
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
{
  "fileId": "text",
  "status": "text",
  "results": {
    "timestamp": "text",
    "fields": []
  }
}