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
  • Fetch file metadata
  • Fetching source file and images
  • Fetch source file (deprecated)
  • Delete a document

Was this helpful?

  1. Upload and Extract

File management

Retrieve document metadata

This is an API guide stub. Documentation is currently under construction.

Fetch file metadata

GET app/docs/{doc_id}

Path Parameters:

  • doc_id the unique identifier for the document

Fetching source file and images

The fetch file metadata endpoint generates signed urls that will allow you to access your original source file as well as the converted images directly from our storage in the cloud. Please use this method for fetching files instead of the deprecated endpoint mentioned below. Urls for the images will be found in the images property in the response, the url for the original file is found in original.

Fetch source file (deprecated)

GET app/docs/{doc_id}/download

Path Parameters:

  • doc_id the unique identifier for the document

Please note: this endpoint has been deprecated in favour of the signed url method mentioned in the 'Fetch file metadata' section above. Please update any implementations using this endpoint before 31/3/2022

Delete a document

DELETE app/docs/{doc_id}

Path Parameters:

  • doc_id the unique identifier for the document to delete

PreviousUpload and Extract (v1)NextReal-time validation

Last updated 3 years ago

Was this helpful?