GET
/
api
/
dataset
/
scroll_files
Scroll Files with Groups
curl --request GET \
  --url https://api.trieve.ai/api/dataset/scroll_files \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'
{
  "file_with_chunk_groups": [
    {
      "chunk_groups": [
        {
          "created_at": "2021-01-01 00:00:00.000",
          "dataset_id": "f83f08ef-c05d-421c-baf1-4f1509ea069b",
          "description": "",
          "id": "df1b73ec-1e62-44bc-b07e-b04485217842",
          "metadata": {},
          "name": "uploadme.pdf",
          "tag_set": [],
          "tracking_id": "file-upload-group",
          "updated_at": "2021-01-01 00:00:00.000"
        }
      ],
      "created_at": "2021-01-01 00:00:00.000",
      "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "file_name": "file.txt",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "link": "https://trieve.ai",
      "metadata": {
        "key": "value"
      },
      "size": 1000,
      "tag_set": "tag1,tag2",
      "time_stamp": "2021-01-01 00:00:00.000",
      "updated_at": "2021-01-01 00:00:00.000"
    }
  ],
  "next_cursor": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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.

Query Parameters

​
cursor
string | null

The cursor to fetch files from. If not specified, will fetch from the beginning. File ids are compared to the cursor using a greater than or equal to.

​
page_size
integer | null

The page size of files you wish to fetch. Defaults to 10.

Required range: x >= 0

Response

200
application/json

JSON body representing the files along with their associated groups in the current dataset

The response is of type object.