BRbraintrustdata
Datasets

Restore dataset

Changed on

Restore a dataset to an earlier version, such as a dataset snapshot. Rows changed since that version are reverted, and rows created since then are deleted. The restore is recorded as a new transaction, so dataset history is preserved. Fails if more than 20,000 rows changed since the requested version. Requires update permission on the dataset.

post/v1/dataset/{dataset_id}/restore

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Path parameters

dataset_idstring uuid required

Dataset id

Request body

versionstring required

The dataset version to restore to, such as the xact_id of a dataset snapshot

Response

Number of rows the restore changed

xact_idstring nullable required

Transaction id of the restore, or null if the restore made no changes

rows_restoredinteger required

Number of rows restored to their value at the requested version

rows_deletedinteger required

Number of rows created after the requested version that were deleted

Changes