Upload document

POST {{baseUrl}}/api/{{apiV3Version}}/document-tool/pre-processing

Upload a document to iDox.ai. Multiple file types are supported, 42 in total; including:

  1. PDF file
  2. Microsoft Office files
    Word - DOC, DOCX, DOCM, DOT, DOTX, DOTM
    Excel - XLS, XLSX, XLSM, XLSB, XLT, XLTX, XLTM
    PowerPoint - PPT, PPTX, PPTM, POT, POTX, POTM, PPS, PPSX, PPSM
    Visio - VSD, VSDX
  3. Image files
    BMP, DIB, GIF, JFIF, JPE, JPEG, JPG, PJPG, PNG, TIF, TIFF
  4. Text & rich text files
    CSV, TEXT, TXT, RTF
  5. HTML files
    HTML, SHTML

Request Body

[{"name"=>"file", "value"=>nil, "datatype"=>"null"}, {"name"=>"callback", "value"=>"", "datatype"=>"null"}]

HEADERS

KeyDatatypeRequiredDescription
{{idoxAPIKey}}stringPlease sign-up iDox.ai and get an API key.

RESPONSES

status: OK

{"jobId":"623acfb33797606f72d33a06","taskCategory":"DOC_TOOL","taskSubcategory":"PRE_PROCESSING","status":"Processing","startDateTime":"2022-03-23T07:43:47.685Z","expirationDateTime":"2022-03-24T07:43:47.685Z"}