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
Create or Upsert Chunk or Chunks
Create new chunk(s). If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
curl --request POST \
--url https://api.trieve.ai/api/chunk \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"chunk_html": "<p>Some HTML content</p>",
"fulltext_boost": {
"boost_factor": 5,
"phrase": "foo"
},
"group_ids": [
"d290f1ee-6c54-4b01-90e6-d701748f0851"
],
"group_tracking_ids": [
"group_tracking_id"
],
"image_urls": [
"https://example.com/red",
"https://example.com/blue"
],
"link": "https://example.com",
"location": {
"lat": -34,
"lon": 151
},
"metadata": {
"key1": "value1",
"key2": "value2"
},
"semantic_boost": {
"distance_factor": 0.5,
"phrase": "flagship"
},
"tag_set": [
"tag1",
"tag2"
],
"time_stamp": "2021-01-01 00:00:00.000",
"tracking_id": "tracking_id"
}'
{
"chunk_metadata": [
{
"content": "Some content",
"link": "https://example.com",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"tag_set": [
"tag1",
"tag2"
],
"time_stamp": "2021-01-01 00:00:00.000",
"tracking_id": "tracking_id",
"weight": 0.5
}
],
"pos_in_queue": 1
}
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
JSON request payload to create a new chunk (chunk)
Request payload for creating a new chunk
Request payload for creating a new chunk
The body is of type single · object[]
.
Response
JSON response payload containing the created chunk
The response is of type object
.
The response is of type object
.
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.trieve.ai/api/chunk \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"chunk_html": "<p>Some HTML content</p>",
"fulltext_boost": {
"boost_factor": 5,
"phrase": "foo"
},
"group_ids": [
"d290f1ee-6c54-4b01-90e6-d701748f0851"
],
"group_tracking_ids": [
"group_tracking_id"
],
"image_urls": [
"https://example.com/red",
"https://example.com/blue"
],
"link": "https://example.com",
"location": {
"lat": -34,
"lon": 151
},
"metadata": {
"key1": "value1",
"key2": "value2"
},
"semantic_boost": {
"distance_factor": 0.5,
"phrase": "flagship"
},
"tag_set": [
"tag1",
"tag2"
],
"time_stamp": "2021-01-01 00:00:00.000",
"tracking_id": "tracking_id"
}'
{
"chunk_metadata": [
{
"content": "Some content",
"link": "https://example.com",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"tag_set": [
"tag1",
"tag2"
],
"time_stamp": "2021-01-01 00:00:00.000",
"tracking_id": "tracking_id",
"weight": 0.5
}
],
"pos_in_queue": 1
}