Skip to main content

Getting Started

The Data Curation API is hosted within the Hyland infrastructure. It can be interacted with via API endpoints.

Requirements​

Endpoints​

As the API is hosted by Hyland, endpoints for access must be provided for usage by Hyland.

HxAI Service Account​

In order to utilize the endpoints, you must also have an appropriate service account registered in the environment to be used. An initial administration account for Hyland Experience must be provided by Hyland, but afterward further accounts can be configured by following the steps in this guide.

Usage, in Brief​

The basic steps of using the Data Curation API are as follows. For more detailed information, please see the tutorial for "Using the API".

  1. Get an access token by calling the authentication URL
  2. Call the presign endpoint to get the following information:
    • job_id
    • put_url
    • get_url
  3. Send the files to process to the put_url
  4. (Optional) The job_id can be used to check the job status
  5. Once the task has been completed, the get_url will return the file results