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
Upload File
Upload a file to S3 bucket attached to your dataset. You can select between a naive chunking strategy where the text is extracted with Apache Tika and split into segments with a target number of segments per chunk OR you can use a vision LLM to convert the file to markdown and create chunks per page. You must specifically use a base64url encoding. Auth’ed user must be an admin or owner of the dataset’s organization to upload a file.
POST
/
api
/
file
Copy
Ask AI
curl --request POST \
--url https://api.trieve.ai/api/file \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"base64_file": "<base64_encoded_file>",
"create_chunks": true,
"description": "This is an example file",
"file_name": "example.pdf",
"link": "https://example.com",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"split_delimiters": [
",",
".",
"\n"
],
"tag_set": [
"tag1",
"tag2"
],
"target_splits_per_chunk": 20,
"time_stamp": "2021-01-01 00:00:00.000Z",
"use_pdf2md_ocr": false
}'
Copy
Ask AI
{
"file_metadata": {
"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"
}
}
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.
Body
application/json
JSON request payload to upload a file
The body is of type object
.
Response
200
application/json
Confirmation that the file is uploading
The response is of type object
.
Was this page helpful?
Copy
Ask AI
curl --request POST \
--url https://api.trieve.ai/api/file \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"base64_file": "<base64_encoded_file>",
"create_chunks": true,
"description": "This is an example file",
"file_name": "example.pdf",
"link": "https://example.com",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"split_delimiters": [
",",
".",
"\n"
],
"tag_set": [
"tag1",
"tag2"
],
"target_splits_per_chunk": 20,
"time_stamp": "2021-01-01 00:00:00.000Z",
"use_pdf2md_ocr": false
}'
Copy
Ask AI
{
"file_metadata": {
"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"
}
}
Assistant
Responses are generated using AI and may contain mistakes.