Retrieve dataset version by name

curl -X POST http://localhost:5173/api/v1/private/datasets/id/versions/retrieve \
     -H "Content-Type: application/json" \
     -d '{
  "version_name": "v12"
}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dataset_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "version_hash": "a1b2c3d4e5f67890abcdef1234567890",
  "tags": [
    "production",
    "validated"
  ],
  "is_latest": false,
  "version_name": "v12",
  "items_total": 15000,
  "items_added": 500,
  "items_modified": 200,
  "items_deleted": 100,
  "change_description": "Added new user data and fixed label inconsistencies",
  "metadata": {},
  "evaluators": [
    {
      "name": "Accuracy Evaluator",
      "type": "code_metric",
      "config": {}
    }
  ],
  "execution_policy": {
    "runs_per_item": 3,
    "pass_threshold": 85
  },
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "data.engineer@company.com",
  "last_updated_at": "2024-02-10T14:45:00Z",
  "last_updated_by": "ml.lead@company.com"
}

Get a specific version by its version name (e.g., ‘v1’, ‘v373’). This is more efficient than paginating through all versions for large datasets.

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

version_namestringRequiredformat: "^v\d+$">=1 character

Version name in format ‘vN’ (e.g., ‘v1’, ‘v373’)

Response

Dataset version

idstringRead-onlyformat: "uuid"

dataset_idstringRead-onlyformat: "uuid"

version_hashstringRead-only

tagslist of stringsRead-only

is_latestbooleanRead-only

Indicates whether this is the latest version of the dataset

version_namestringRead-only

Sequential version name formatted as 'v1', 'v2', etc.

items_totalintegerRead-only

Total number of items in this version

items_addedintegerRead-only

Number of items added since last version

items_modifiedintegerRead-only

Number of items modified since last version

items_deletedintegerRead-only

Number of items deleted since last version

change_descriptionstringRead-only

metadatamap from strings to stringsRead-only

evaluatorslist of objectsRead-only

Default evaluators for items in this version

execution_policyobjectRead-only

Default execution policy for items in this version

created_atdatetimeRead-only

created_bystringRead-only

last_updated_atdatetimeRead-only

last_updated_bystringRead-only

Errors

400

Bad Request Error

404

Not Found Error