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. Upload Document

POST - Upload JSON

PreviousPOST - Upload DocumentNextResults

Last updated 3 years ago

Was this helpful?

post

Optional upload endpoint that allows uploading files as base64 in an application/json payload. Please supply a valid bearerToken and products or fieldSet or fieldSets.

Authorizations
Body
tagsstring[]Optional

tags associated with your file

productsstring[]Optional

Array of products to predict on. Cannot be supplied with fieldSet or fieldSets

fieldSetstringOptional

A single field set for extraction

fieldSetsstring[]Optional

Optionally use this parameter to extract an array of field sets. Needs to be a json array in a string.

Responses
200
File was successfully uploaded.
application/json
default
Error
application/json
{
  "fileId": "text",
  "uploadedAt": "text",
  "status": "text"
}