PUT
/
api
/
dataset

Authorizations

Authorization
string
headerrequired

Headers

TR-Organization
string
required

The organization id to use for the request

Body

application/json
crawl_options
object

Options for setting up the crawl which will populate the dataset.

dataset_id
string | null

The id of the dataset you want to update.

dataset_name
string | null

The new name of the dataset. Must be unique within the organization. If not provided, the name will not be updated.

new_tracking_id
string | null

Optional new tracking ID for the dataset. Can be used to track the dataset in external systems. Must be unique within the organization. If not provided, the tracking ID will not be updated. Strongly recommended to not use a valid uuid value as that will not work with the TR-Dataset header.

server_configuration
object

Lets you specify the configuration for a dataset

tracking_id
string | null

The tracking ID of the dataset you want to update.

Response

200 - application/json
created_at
string
required

Timestamp of the creation of the dataset

deleted
integer
required

Flag to indicate if the dataset has been deleted. Deletes are handled async after the flag is set so as to avoid expensive search index compaction.

id
string
required

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

name
string
required

Name of the dataset

organization_id
string
required

Unique identifier of the organization that owns the dataset

server_configuration
any
required

Configuration of the dataset for RAG, embeddings, BM25, etc.

tracking_id
string | null

Tracking ID of the dataset, can be any string, determined by the user. Tracking ID's are unique identifiers for datasets within an organization. They are designed to match the unique identifier of the dataset in the user's system.

updated_at
string
required

Timestamp of the last update of the dataset

Batch Create DatasetsDelete Dataset