> 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/get-dataset-by-identifier/llms.txt.

# Get dataset by name

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

Get dataset by name

Reference: https://www.comet.com/docs/opik/reference/rest-api/datasets/get-dataset-by-identifier

## Servers

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

## Request

### Body (application/json)

This endpoint expects a DatasetIdentifier_Public.

- `dataset_name` (string, required)
- `project_name` (string, optional)

## Response

### 200

Dataset resource

- `name` (string, required)
- `id` (string, optional)
- `project_id` (string, optional) — Project ID. Takes precedence over project_name when both are provided.
- `type` (enum, optional)
  - Allowed values: `dataset`, `evaluation_suite`
- `visibility` (enum, optional)
  - Allowed values: `private`, `public`
- `tags` (list of string, optional)
- `description` (string, optional)
- `created_at` (datetime, optional)
- `created_by` (string, optional)
- `last_updated_at` (datetime, optional)
- `last_updated_by` (string, optional)
- `experiment_count` (long, optional)
- `dataset_items_count` (long, optional)
- `optimization_count` (long, optional)
- `most_recent_experiment_at` (datetime, optional)
- `last_created_experiment_at` (datetime, optional)
- `most_recent_optimization_at` (datetime, optional)
- `last_created_optimization_at` (datetime, optional)
- `status` (enum, optional)
  - Allowed values: `unknown`, `processing`, `completed`, `failed`
- `latest_version` (DatasetVersionSummary_Public, optional) — Summary of the latest dataset version

## Types

### DatasetVersionSummary_Public

Summary of the latest dataset version

- `id` (string, optional) — Unique identifier of the version
- `version_hash` (string, optional) — Hash of the version content
- `version_name` (string, optional) — Sequential version name formatted as 'v1', 'v2', etc.
- `change_description` (string, optional) — Description of changes in this version
- `tags` (list of string, optional) — Tags associated with this version

## Examples

**Request**

```json
{
  "dataset_name": "string"
}
```

**Response**

```json
{
  "name": "string",
  "id": "string",
  "project_id": "string",
  "type": "dataset",
  "visibility": "private",
  "tags": [
    "string"
  ],
  "description": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_at": "2024-01-15T09:30:00Z",
  "last_updated_by": "string",
  "experiment_count": 1,
  "dataset_items_count": 1,
  "optimization_count": 1,
  "most_recent_experiment_at": "2024-01-15T09:30:00Z",
  "last_created_experiment_at": "2024-01-15T09:30:00Z",
  "most_recent_optimization_at": "2024-01-15T09:30:00Z",
  "last_created_optimization_at": "2024-01-15T09:30:00Z",
  "status": "unknown",
  "latest_version": {
    "id": "string",
    "version_hash": "string",
    "version_name": "string",
    "change_description": "string",
    "tags": [
      "string"
    ]
  }
}
```

**SDK Code**

```python
import requests

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

payload = { "dataset_name": "string" }
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/retrieve';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"dataset_name":"string"}'
};

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/retrieve"

	payload := strings.NewReader("{\n  \"dataset_name\": \"string\"\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/retrieve")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset_name\": \"string\"\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/retrieve")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_name\": \"string\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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

```swift
import Foundation

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

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

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:5173/api/v1/private/datasets/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.