--- title: "Scroll Chunks" method: POST path: "/api/chunks/scroll" tags: ["Chunk"] --- # Scroll Chunks `POST /api/chunks/scroll` Get paginated chunks from your dataset with filters and custom sorting. If sort by is not specified, the results will sort by the id's of the chunks in ascending order. Sort by and offset_chunk_id cannot be used together; if you want to scroll with a sort by then you need to use a must_not filter with the ids you have already seen. There is a limit of 1000 id's in a must_not filter at a time. ## Headers - `TR-Dataset` string, uuid, required ## Request body - ScrollChunksReqPayload - `filters` ChunkFilter — 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. - `must` ConditionType[], nullable — All of these field conditions have to match for the chunk to be included in the result set. - union — Filters can be constructed using either fields on the chunk objects, ids or tracking ids of chunks, and finally ids or tracking ids of groups. - FieldCondition — FieldCondition is a JSON object which can be used to filter chunks by a field. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. - `boolean` boolean, nullable — Boolean is a true false value for a field. This only works for boolean fields. You can specify this if you want values to be true or false. - `date_range` DateRange — DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone. - `gt` string, nullable - `gte` string, nullable - `lt` string, nullable - `lte` string, nullable - `field` string, required — Field is the name of the field to filter on. Commonly used fields are `timestamp`, `link`, `tag_set`, `location`, `num_value`, `group_ids`, and `group_tracking_ids`. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. - `geo_bounding_box` LocationBoundingBox - `bottom_right` GeoInfo, required — Location that you want to use as the center of the search. - … - `top_left` GeoInfo, required — Location that you want to use as the center of the search. - … - `geo_polygon` LocationPolygon - `exterior` GeoInfo[], required - … - `interior` array[], nullable - … - `geo_radius` LocationRadius - `center` GeoInfo, required — Location that you want to use as the center of the search. - … - `radius` number, double, required - `match_all` MatchCondition[], nullable — Match all lets you pass in an array of values that will return results if all of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used. - union - … - `match_any` MatchCondition[], nullable — Match any lets you pass in an array of values that will return results if any of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used. - union - … - `range` Range - `gt` union - … - `gte` union - … - `lt` union - … - `lte` union - … - HasChunkIDCondition — HasChunkIDCondition is a JSON object which can be used to filter chunks by their ids or tracking ids. This is useful for when you want to filter chunks by their ids or tracking ids. - `ids` string[], nullable — Ids of the chunks to apply a match_any condition with. Only chunks with one of these ids will be returned. - `tracking_ids` string[], nullable — Tracking ids of the chunks to apply a match_any condition with. Only chunks with one of these tracking ids will be returned. - `must_not` ConditionType[], nullable — None of these field conditions can match for the chunk to be included in the result set. - union — Filters can be constructed using either fields on the chunk objects, ids or tracking ids of chunks, and finally ids or tracking ids of groups. - FieldCondition — FieldCondition is a JSON object which can be used to filter chunks by a field. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. - `boolean` boolean, nullable — Boolean is a true false value for a field. This only works for boolean fields. You can specify this if you want values to be true or false. - `date_range` DateRange — DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone. - `gt` string, nullable - `gte` string, nullable - `lt` string, nullable - `lte` string, nullable - `field` string, required — Field is the name of the field to filter on. Commonly used fields are `timestamp`, `link`, `tag_set`, `location`, `num_value`, `group_ids`, and `group_tracking_ids`. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. - `geo_bounding_box` LocationBoundingBox - `bottom_right` GeoInfo, required — Location that you want to use as the center of the search. - … - `top_left` GeoInfo, required — Location that you want to use as the center of the search. - … - `geo_polygon` LocationPolygon - `exterior` GeoInfo[], required - … - `interior` array[], nullable - … - `geo_radius` LocationRadius - `center` GeoInfo, required — Location that you want to use as the center of the search. - … - `radius` number, double, required - `match_all` MatchCondition[], nullable — Match all lets you pass in an array of values that will return results if all of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used. - union - … - `match_any` MatchCondition[], nullable — Match any lets you pass in an array of values that will return results if any of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used. - union - … - `range` Range - `gt` union - … - `gte` union - … - `lt` union - … - `lte` union - … - HasChunkIDCondition — HasChunkIDCondition is a JSON object which can be used to filter chunks by their ids or tracking ids. This is useful for when you want to filter chunks by their ids or tracking ids. - `ids` string[], nullable — Ids of the chunks to apply a match_any condition with. Only chunks with one of these ids will be returned. - `tracking_ids` string[], nullable — Tracking ids of the chunks to apply a match_any condition with. Only chunks with one of these tracking ids will be returned. - `should` ConditionType[], nullable — Only one of these field conditions has to match for the chunk to be included in the result set. - union — Filters can be constructed using either fields on the chunk objects, ids or tracking ids of chunks, and finally ids or tracking ids of groups. - FieldCondition — FieldCondition is a JSON object which can be used to filter chunks by a field. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. - `boolean` boolean, nullable — Boolean is a true false value for a field. This only works for boolean fields. You can specify this if you want values to be true or false. - `date_range` DateRange — DateRange is a JSON object which can be used to filter chunks by a range of dates. This leverages the time_stamp field on chunks in your dataset. You can specify this if you want values in a certain range. You must provide ISO 8601 combined date and time without timezone. - `gt` string, nullable - `gte` string, nullable - `lt` string, nullable - `lte` string, nullable - `field` string, required — Field is the name of the field to filter on. Commonly used fields are `timestamp`, `link`, `tag_set`, `location`, `num_value`, `group_ids`, and `group_tracking_ids`. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. - `geo_bounding_box` LocationBoundingBox - `bottom_right` GeoInfo, required — Location that you want to use as the center of the search. - … - `top_left` GeoInfo, required — Location that you want to use as the center of the search. - … - `geo_polygon` LocationPolygon - `exterior` GeoInfo[], required - … - `interior` array[], nullable - … - `geo_radius` LocationRadius - `center` GeoInfo, required — Location that you want to use as the center of the search. - … - `radius` number, double, required - `match_all` MatchCondition[], nullable — Match all lets you pass in an array of values that will return results if all of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used. - union - … - `match_any` MatchCondition[], nullable — Match any lets you pass in an array of values that will return results if any of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used. - union - … - `range` Range - `gt` union - … - `gte` union - … - `lt` union - … - `lte` union - … - HasChunkIDCondition — HasChunkIDCondition is a JSON object which can be used to filter chunks by their ids or tracking ids. This is useful for when you want to filter chunks by their ids or tracking ids. - `ids` string[], nullable — Ids of the chunks to apply a match_any condition with. Only chunks with one of these ids will be returned. - `tracking_ids` string[], nullable — Tracking ids of the chunks to apply a match_any condition with. Only chunks with one of these tracking ids will be returned. - `offset_chunk_id` string, uuid, nullable — 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, nullable — Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. - `sort_by` SortByField - `direction` 'desc' | 'asc' - `field` string, required — Field to sort by. This has to be a numeric field with a Qdrant `Range` index on it. i.e. num_value and timestamp - `prefetch_amount` integer, nullable — How many results to pull in before the sort ## Response `200` Number of chunks equivalent to page_size starting from offset_chunk_id - ScrollChunksResponseBody - `chunks` ChunkMetadata[], required - `chunk_html` string, nullable — HTML content of the chunk, can also be an arbitrary string which is not HTML - `created_at` string, date-time, required — Timestamp of the creation of the chunk - `dataset_id` string, uuid, required — ID of the dataset which the chunk belongs to - `id` string, uuid, required — Unique identifier of the chunk, auto-generated uuid created by Trieve - `image_urls` string[], nullable — Image URLs of the chunk, can be any list of strings. Used for image search and RAG. - `link` string, nullable — Link to the chunk, should be a URL - `location` GeoInfo — Location that you want to use as the center of the search. - `lat` union, required - integer - number, double - `lon` union, required - integer - number, double - `metadata` unknown - `num_value` number, double, nullable — Numeric value of the chunk, can be any float. Can represent the most relevant numeric value of the chunk, such as a price, quantity in stock, rating, etc. - `tag_set` string[], nullable — Tag set of the chunk, can be any list of strings. Used for tag-filtered searches. - `time_stamp` string, date-time, nullable — Timestamp of the chunk, can be any timestamp. Specified by the user. - `tracking_id` string, nullable — Tracking ID of the chunk, can be any string, determined by the user. Tracking ID's are unique identifiers for chunks within a dataset. They are designed to match the unique identifier of the chunk in the user's system. - `updated_at` string, date-time, required — Timestamp of the last update of the chunk - `weight` number, double, required — Weight of the chunk, can be any float. Used as a multiplier on a chunk's relevance score for ranking purposes. ## Other responses - `400` — Service error relating to scrolling chunks --- [API](https://skmtc.net/devflowinc/apis/trieve-api.md) · [All operations](https://skmtc.net/devflowinc/apis/trieve-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/devflowinc/trieve-api/revisions/84583e7c9fc1/schema)