GET
/
api
/
chunk
/
tracking_id
/
{tracking_id}
curl --request GET \
  --url https://api.trieve.ai/api/chunk/tracking_id/{tracking_id} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'
{
  "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
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.

​
X-API-Version
enum<string>

The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.

Available options:
V1,
V2

Path Parameters

​
tracking_id
string
required

tracking_id of the chunk you want to fetch

Response

200
application/json
chunk with the tracking_id that you were searching for
​
created_at
string
required

Timestamp of the creation of the chunk

​
dataset_id
string
required

ID of the dataset which the chunk belongs to

​
id
string
required

Unique identifier of the chunk, auto-generated uuid created by Trieve

​
updated_at
string
required

Timestamp of the last update of the chunk

​
weight
number
required

Weight of the chunk, can be any float. Used as a multiplier on a chunk's relevance score for ranking purposes.

​
chunk_html
string | null

HTML content of the chunk, can also be an arbitrary string which is not HTML

​
image_urls
(string | null)[] | null

Image URLs of the chunk, can be any list of strings. Used for image search and RAG.

​
link
string | null

Link to the chunk, should be a URL

​
location
object

Location that you want to use as the center of the search.

​
metadata
any | null

Metadata of the chunk, can be any JSON object

​
num_value
number | null

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 | null)[] | null

Tag set of the chunk, can be any list of strings. Used for tag-filtered searches.

​
time_stamp
string | null

Timestamp of the chunk, can be any timestamp. Specified by the user.

​
tracking_id
string | null

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.

Was this page helpful?

Raise issue