Skip to main content
POST
Create dataset_snapshot

Authorizations

Authorization
string
header
required

Most Braintrust endpoints are authenticated by providing your API key as a header Authorization: Bearer [api_key] to your HTTP request. You can create an API key in the Braintrust organization settings page.

Body

application/json

Any desired information about the new dataset_snapshot object

dataset_id
string<uuid>
required

Unique identifier for the dataset that this snapshot belongs to

name
string
required

Name of the dataset snapshot

Minimum string length: 1
xact_id
string
required

Transaction id of the brainstore version at the time of the snapshot

Minimum string length: 1
description
string | null

Textual description of the dataset snapshot

Response

Returns the new dataset_snapshot object

id
string<uuid>
required

Unique identifier for the dataset snapshot

dataset_id
string<uuid>
required

Unique identifier for the dataset that this snapshot belongs to

name
string
required

Name of the dataset snapshot

description
string | null
required
xact_id
string
required

Transaction id of the brainstore version at the time of the snapshot

created
string<date-time> | null
required

Date of dataset snapshot creation