v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Chunk Group

Get Groups for Dataset

Fetch the groups which belong to a dataset specified by its id.

get/api/dataset/groups/{dataset_id}/{page}

Path parameters

dataset_idstring uuid required

The id of the dataset to fetch groups for.

pageinteger nullable required

The page of groups to fetch. Page is 1-indexed. Only used if use_cursor = false.

Query parameters

use_cursorboolean nullable

Flag to enable cursor mode, this runs faster for large scroll operations. Defaults to false

cursorstring uuid nullable

The cursor offset for. Requires use_cursor = True. Defaults to 00000000-00000000-00000000-00000000. Group ids are compared to the cursor using a greater than or equal to.

Headers

TR-Datasetstring uuid required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Response

JSON body representing the groups created by the given dataset

next_cursorstring uuid nullable

Parameter for the next cursor offset.

total_pagesinteger required

Total number of pages. Pages is groups_count / 10

Example response

{
  "groups": [
    {
      "created_at": "2021-01-01 00:00:00.000",
      "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "description": "A group of chunks",
      "file_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "name": "Trieve",
      "tracking_id": "3",
      "updated_at": "2021-01-01 00:00:00.000"
    }
  ]
}