Create a Dataset from a Local Folder for On-Prem Installations

​

API Overview

To create a dataset using a local folder, issue a request to the processing endpoint with the dataset name and path.

​

Endpoint Format

http://[host]:2080/api/v1/process?path=[full data folder path]&name=[dataset name]

​

Parameters

​

Example Request

Assume you want to process a dataset located at /data/project/images and name it visual_analysis_01.

http://example.com:2080/api/v1/process?path=/data/project/images&name=visual_analysis_01

​

Example Response

{
  "status": "success",
  "message": "Dataset processing started",
  "dataset_id": "12345",
  "name": "visual_analysis_01"
}

​

Error Handling

In case of a failure, the API returns a descriptive error response. Common issues include:

• Invalid or non-existent path
• Missing path or name parameters
• Server unavailable or internal failure

​

Example Error Response

{
  "status": "error",
  "message": "Invalid path specified"
}

​

Notes & Considerations

• Only one dataset can be processed at a time.
• If another dataset is already being processed, the request will be rejected.
• Make sure the server is up and the API port is accessible.
• The folder path must contain valid files for enrichment and must be readable by the system.
• Dataset names should be unique to prevent overwriting or collisions.