DataOnboarding

Datasets

Inspect and manage the output of onboarding.
View as Markdown

A dataset is the result of onboarding.

It represents a datasource after the platform has prepared it for model training. Training workflows use datasets as their input.

Initial and incremental datasets

The first successful onboarding job creates an initial dataset.

Later onboarding jobs can create incremental datasets that build on the original dataset. Incremental datasets keep a reference to their parent dataset and include an increment_index and increment_label so updates can be traced over time.

Retrieve datasets

Retrieve datasets when you need to find the dataset created by an onboarding job or select a dataset for training.

GET
/datasets
1curl https://api.hi.umnai.com/datasets \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5      "name": "Sample Organisation",
6      "status": "ACTIVE",
7      "created_at": "2026-03-11T16:04:19.749000Z",
8      "updated_at": null
9    }
10  ],
11  "pagination": {
12    "total_items": 1,
13    "items_per_page": 10,
14    "current_page": 1,
15    "total_pages": 1
16  }
17}

You can filter the list by data_processing_job_id when you want the dataset produced by a specific onboarding job.

Retrieve a dataset

Retrieve a dataset by id when you need to inspect a specific dataset before training.

GET
/datasets/:datasetId
1curl https://api.hi.umnai.com/datasets/{datasetId} \
2     -H "Authorization: Bearer <token>"
Response
1{
2  "data": [
3    {
4      "id": "ea8b745ead39ec442fc3b4fba359bf98",
5      "name": "Sample Organisation",
6      "status": "ACTIVE",
7      "created_at": "2026-03-11T16:04:19.749000Z",
8      "updated_at": null
9    }
10  ],
11  "pagination": {
12    "total_items": 1,
13    "items_per_page": 10,
14    "current_page": 1,
15    "total_pages": 1
16  }
17}

Update a dataset

Update a dataset when you need to rename it.

PATCH
/datasets/:datasetId
1curl -X PATCH https://api.hi.umnai.com/datasets/datasetId \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": "Sample Dataset"
6}'
Response
1{
2  "id": "3c4d09e4ef50b370ae0efacdb43ec2dd",
3  "name": "Sample Dataset",
4  "increment_index": 0,
5  "increment_label": "sample_increment_label",
6  "account": {
7    "id": "e268443e43d93dab7ebef303bbe9642f",
8    "name": "Sample Account"
9  },
10  "datasource": {
11    "id": "1ea7e575defdf6bc3f26a3f127e98170",
12    "name": "Sample Datasource"
13  },
14  "data_processing_job": {
15    "id": "fa895821d8f17f02c48bd90f4c98f4bd",
16    "name": "Sample Onboarding Job"
17  },
18  "status": "AVAILABLE",
19  "created_at": "2026-03-15T10:15:30.000000Z",
20  "parent_dataset": {
21    "id": "c0ff256f34131d684db5d5212b7cee39",
22    "name": "Sample Parent Dataset"
23  },
24  "created_by": {
25    "id": "dad46b2058752ffde5eaf02f1eb6abd5",
26    "name": "Sample User"
27  },
28  "updated_at": "2026-03-15T10:15:30.000000Z",
29  "tags": [
30    {
31      "name": "Sample Tag"
32    }
33  ]
34}

Delete a dataset

Delete a dataset when it should no longer be used.

DELETE
/datasets/:datasetId
1curl -X DELETE https://api.hi.umnai.com/datasets/datasetId \
2     -H "Authorization: Bearer <token>"

Views

Dataset views help inspect the structure and lineage of prepared training data.

  • Lineage shows how a dataset was created and how it evolved across onboarding runs.
  • Histogram shows the distribution of values in a dataset.