> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://www.comet.com/docs/opik/reference/rest-api/datasets/retrieve-dataset-version/llms.txt.

# Retrieve dataset version by name

POST http://localhost:5173/api/v1/private/datasets/{id}/versions/retrieve
Content-Type: application/json

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

Reference: https://www.comet.com/docs/opik/reference/rest-api/datasets/retrieve-dataset-version

## Servers

- `http://localhost:5173/api` (Local server, default)
- `https://www.comet.com/opik/api` (Opik Cloud)

## Request

### Path parameters

- `id` (string, required)

### Body (application/json)

This endpoint expects a DatasetVersionRetrieveRequest_Public.

- `version_name` (string, required) — Version name in format 'vN' (e.g., 'v1', 'v373')

## Response

### 200

Dataset version

- `id` (string, optional)
- `dataset_id` (string, optional)
- `version_hash` (string, optional)
- `tags` (list of string, optional)
- `is_latest` (boolean, optional) — Indicates whether this is the latest version of the dataset
- `version_name` (string, optional) — Sequential version name formatted as 'v1', 'v2', etc.
- `items_total` (integer, optional) — Total number of items in this version
- `items_added` (integer, optional) — Number of items added since last version
- `items_modified` (integer, optional) — Number of items modified since last version
- `items_deleted` (integer, optional) — Number of items deleted since last version
- `change_description` (string, optional)
- `metadata` (map from string to string, optional)
- `evaluators` (list of EvaluatorItem_Public, optional) — Default evaluators for items in this version
- `execution_policy` (ExecutionPolicy_Public, optional) — Default execution policy for items in this version
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)

## Errors

### 400 Bad Request Error

Bad Request

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

### 404 Not Found Error

Version not found

- `code` (integer, optional)
- `message` (string, optional)
- `details` (string, optional)

## Types

### EvaluatorItem_Public

Default evaluators for items in this version

- `name` (string, required)
- `type` (enum, required)
  - Allowed values: `llm_judge`, `code_metric`
- `config` (JsonNode_Public, required)

### ExecutionPolicy_Public

Default execution policy for items in this version

- `runs_per_item` (integer, optional)
- `pass_threshold` (integer, optional)

### JsonNode_Public

## Examples

**Request**

```json
{
  "version_name": "v1"
}
```

**Response**

```json
{
  "id": "string",
  "dataset_id": "string",
  "version_hash": "string",
  "tags": [
    "string"
  ],
  "is_latest": true,
  "version_name": "string",
  "items_total": 1,
  "items_added": 1,
  "items_modified": 1,
  "items_deleted": 1,
  "change_description": "string",
  "metadata": {},
  "evaluators": [
    {
      "name": "string",
      "type": "llm_judge",
      "config": {}
    }
  ],
  "execution_policy": {
    "runs_per_item": 1,
    "pass_threshold": 1
  },
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string"
}
```

**SDK Code**

```python
import requests

url = "http://localhost:5173/api/v1/private/datasets/id/versions/retrieve"

payload = { "version_name": "v1" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'http://localhost:5173/api/v1/private/datasets/id/versions/retrieve';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"version_name":"v1"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5173/api/v1/private/datasets/id/versions/retrieve"

	payload := strings.NewReader("{\n  \"version_name\": \"v1\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:5173/api/v1/private/datasets/id/versions/retrieve")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version_name\": \"v1\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:5173/api/v1/private/datasets/id/versions/retrieve")
  .header("Content-Type", "application/json")
  .body("{\n  \"version_name\": \"v1\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:5173/api/v1/private/datasets/id/versions/retrieve', [
  'body' => '{
  "version_name": "v1"
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("http://localhost:5173/api/v1/private/datasets/id/versions/retrieve");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"version_name\": \"v1\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["version_name": "v1"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/datasets/id/versions/retrieve")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

> Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards.