GET
/
api
/
dataset
/
groups
/
{dataset_id}
/
{page}
curl --request GET \
  --url https://api.trieve.ai/api/dataset/groups/{dataset_id}/{page} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'
{
  "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"
    }
  ],
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_pages": 1
}

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string
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.

Path Parameters

​
dataset_id
string
required

The id of the dataset to fetch groups for.

​
page
integer | null
required

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

Query Parameters

​
use_cursor
boolean | null

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

​
cursor
string | null

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.

Response

200
application/json
JSON body representing the groups created by the given dataset
​
groups
object[]
required

The list of all the groups.

​
total_pages
integer
required

Total number of pages. Pages is groups_count / 10

Required range: x >= 0
​
next_cursor
string | null

Parameter for the next cursor offset.

Was this page helpful?

Raise issue