POST
/
api
/
chunks
/
scroll
Scroll Chunks
curl --request POST \
  --url https://api.trieve.ai/api/chunks/scroll \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "filters": {
    "must": [
      {
        "field": "tag_set",
        "match_all": [
          "A",
          "B"
        ]
      },
      {
        "field": "num_value",
        "range": {
          "gte": 10,
          "lte": 25
        }
      }
    ]
  },
  "offset_chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "page_size": 1,
  "sort_by": {
    "direction": "desc",
    "field": "<string>",
    "prefetch_amount": 1
  }
}'
{
  "chunks": [
    {
      "chunk_html": "<p>Hello, world!</p>",
      "created_at": "2021-01-01 00:00:00.000",
      "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "link": "https://trieve.ai",
      "metadata": {
        "key": "value"
      },
      "tag_set": "[tag1,tag2]",
      "time_stamp": "2021-01-01 00:00:00.000",
      "tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
      "updated_at": "2021-01-01 00:00:00.000",
      "weight": 0.5
    }
  ]
}

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.

Body

application/json

JSON request payload to scroll through chunks (chunks)

​
filters
object

ChunkFilter is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.

Example:
{
  "must": [
    {
      "field": "tag_set",
      "match_all": ["A", "B"]
    },
    {
      "field": "num_value",
      "range": { "gte": 10, "lte": 25 }
    }
  ]
}
​
offset_chunk_id
string<uuid> | null

Offset chunk id is the id of the chunk to start the page from. If not specified, this defaults to the first chunk in the dataset sorted by id ascending.

​
page_size
integer | null

Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.

Required range: x >= 0
​
sort_by
object

Response

Number of chunks equivalent to page_size starting from offset_chunk_id

​
chunks
V2 · object[]
required