Sypht AppHelp CenterMarketplace
Search…
Introduction
Setup
Authentication
Upload and Extract
Upload and Extract
File management
Workflows
Real-time validation
Smart document split
Entity matching
Field types
Line Items
Classification fields
Signals
Values
API Docs
API Introduction
Authentication
Upload Document
Results
Upload Annotation
Powered By GitBook
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
​
Upload and Extract - Previous
Upload and Extract
Next - Workflows
Real-time validation
Last modified 3mo ago
Copy link
Contents
Fetch file metadata
Fetching source file and images
Fetch source file (deprecated)
Delete a document