Skip to main content

Getting started

Context API is hosted on Hyland Expirience platform

Requirements​

  • basic knowledge about HTTP and REST API interactions
  • HX Subscripttion to Context API
  • Service User configured for roles
  • External Application Client configured

Usage​

Context API expose following endpoints:
/actions - provides list of the available extraction types available for Consumer to execute on documents.
/process - endpoint for requesting extractions process execution- for selected actions of choice and documents
/presigned-url - provides presigned-url used for uploading document files
{id}/results - endpoint for processing results retrieval/ /health - anonymous access endpoint checking availablility of Context service

Consumer first uploads documents using presigned-urls recived via Context API, for each documnet object key must be persisted. To request processing consumer uses objects keys and selected actions (some actions may require additional fields to be provided)

Usage sequence​

alt text