Chunk
- POSTCreate or Upsert Chunk or Chunks
- POSTSearch
- POSTAutocomplete
- POSTGet Recommended Chunks
- POSTScroll Chunks
- POSTCount chunks above threshold
- POSTGenerate suggested queries
- POSTRAG on Specified Chunks
- PUTUpdate Chunk
- PUTUpdate Chunk By Tracking Id
- GETGet Chunk By Id
- GETGet Chunk By Tracking Id
- POSTGet Chunks By Tracking Ids
- POSTGet Chunks By Ids
- DELDelete Chunk
- DELDelete Chunk By Tracking Id
- DELBulk Delete Chunks
- POSTSplit HTML Content into Chunks
Chunk Group
- POSTCreate or Upsert Group or Groups
- POSTSearch Over Groups
- POSTAutocomplete Search Over Groups
- POSTSearch Within Group
- POSTGet Recommended Groups
- POSTAdd Chunk to Group
- POSTAdd Chunk to Group by Tracking ID
- POSTGet Groups for Chunks
- GETGet Chunks in Group by Tracking ID
- GETGet Group by Tracking ID
- PUTUpdate Group
- DELRemove Chunk from Group
- DELDelete Group by Tracking ID
- DELDelete Group
- GETGet Group
- GETGet Chunks in Group
- GETGet Groups for Dataset
Message
Crawl
File
Analytics
Dataset
- POSTCreate Dataset
- POSTBatch Create Datasets
- POSTGet All Tags
- POSTGet events for the dataset
- PUTUpdate Dataset by ID or Tracking ID
- PUTClear Dataset
- GETGet Dataset By ID
- GETGet Dataset by Tracking ID
- GETGet Datasets from Organization
- POSTCreate ETL Job
- PUTCreate Pagefind Index for Dataset
- GETGet Pagefind Index Url for Dataset
- GETGet Usage By Dataset ID
- GETGet dataset crawl options
- DELDelete Dataset
- DELDelete Dataset by Tracking ID
- POSTClone Dataset
- GETGet file and chunk creation queue lengths
Organization
Health
Stripe
Metrics
File
Scroll Files with Groups
Scroll through the files along with their groups in a dataset. This is useful for paginating through files. The cursor is used to fetch the next page of files. The page size is used to specify how many files to fetch per page. The default page size is 10.
GET
/
api
/
dataset
/
scroll_files
Copy
Ask AI
curl --request GET \
--url https://api.trieve.ai/api/dataset/scroll_files \
--header 'Authorization: <api-key>' \
--header 'TR-Dataset: <tr-dataset>'
Copy
Ask AI
{
"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
Headers
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
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.
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
.
Was this page helpful?
Copy
Ask AI
curl --request GET \
--url https://api.trieve.ai/api/dataset/scroll_files \
--header 'Authorization: <api-key>' \
--header 'TR-Dataset: <tr-dataset>'
Copy
Ask AI
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.