Get Files and Group IDs for Dataset

Get all files and their group ids which belong to a given dataset specified by the dataset_id parameter. 10 files and group ids are returned per page. This route may return the same file multiple times if the file is associated with multiple groups.

GET /api/dataset/files/{dataset_id}/{page}

Try it

Get Files and Group IDs for Dataset

cURL

curl --request GET \
  --url https://api.trieve.ai/api/dataset/files/{dataset_id}/{page} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'

200

{
  "file_and_group_ids": [
    {
      "file": {
        "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"
      },
      "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "total_pages": 123
}

Authorizations

Authorization · string · header · required

Headers

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

Path Parameters

dataset_id · string<uuid> · required

The id of the dataset to fetch files for.

page · integer<int64> · required

The page number of files you wish to fetch. Each page contains at most 10 files.

Required range: x >= 0

Response

200

application/json

JSON body representing the files and their group ids in the current dataset

file_and_group_ids · object[] · required

Show child attributes

file_and_group_ids. file · object · required

Show child attributes

file_and_group_ids.file. created_at · string<date-time> · required

file_and_group_ids.file. dataset_id · string<uuid> · required

file_and_group_ids.file. file_name · string · required

file_and_group_ids.file. id · string<uuid> · required

file_and_group_ids.file. size · integer<int64> · required

file_and_group_ids.file. updated_at · string<date-time> · required

file_and_group_ids.file. link · string | null

file_and_group_ids.file. metadata · unknown

file_and_group_ids.file. tag_set · (string | null)[] | null

file_and_group_ids.file. time_stamp · string<date-time> | null

Example:

{
  "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"
}

file_and_group_ids. group_id · string<uuid> | null

total_pages · integer<int64> · required