For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • POSTApply changes to dataset items
        • PATCHBatch update dataset items
        • GETFind datasets
        • POSTCreate dataset
        • PUTCreate/update dataset items
        • POSTCreate dataset items from CSV file
        • POSTCreate dataset items from spans
        • POSTCreate dataset items from traces
        • GETGet dataset by id
        • PUTUpdate dataset by id
        • DELDelete dataset by id
        • POSTDelete dataset by name
        • POSTDelete dataset items
        • POSTDelete datasets
        • GETDownload dataset export file
        • POSTExpand dataset with synthetic samples
        • GETFind dataset items with experiment items
        • POSTGet dataset by name
        • GETGet experiment items stats for dataset
        • GETGet dataset export job status
        • GETGet all dataset export jobs
        • GETGet dataset item by id
        • PATCHPartially update dataset item by id
        • GETGet dataset items
        • GETGet dataset items output columns
        • PUTMark dataset export job as viewed
        • POSTStart dataset CSV export
        • POSTStream dataset items
        • GETCompare latest version with draft
        • POSTCreate version tag
        • DELDelete version tag
        • GETList dataset versions
        • POSTRestore dataset to a previous version
        • POSTRetrieve dataset version by name
        • PATCHUpdate dataset version
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceDatasets

Get dataset by name

POST
/v1/private/datasets/retrieve
POST
/api/v1/private/datasets/retrieve
$curl -X POST http://localhost:5173/api/v1/private/datasets/retrieve \
>     -H "Content-Type: application/json" \
>     -d '{
>  "dataset_name": "string"
>}'
200Successful
1{
2  "name": "string",
3  "id": "string",
4  "project_id": "string",
5  "type": "dataset",
6  "visibility": "private",
7  "tags": [
8    "string"
9  ],
10  "description": "string",
11  "created_at": "2024-01-15T09:30:00Z",
12  "created_by": "string",
13  "last_updated_at": "2024-01-15T09:30:00Z",
14  "last_updated_by": "string",
15  "experiment_count": 1,
16  "dataset_items_count": 1,
17  "optimization_count": 1,
18  "most_recent_experiment_at": "2024-01-15T09:30:00Z",
19  "last_created_experiment_at": "2024-01-15T09:30:00Z",
20  "most_recent_optimization_at": "2024-01-15T09:30:00Z",
21  "last_created_optimization_at": "2024-01-15T09:30:00Z",
22  "status": "unknown",
23  "latest_version": {
24    "id": "string",
25    "version_hash": "string",
26    "version_name": "string",
27    "change_description": "string",
28    "tags": [
29      "string"
30    ]
31  }
32}
Get dataset by name
Was this page helpful?
Previous

Get experiment items stats for dataset

Next
Built with

Request

This endpoint expects an object.
dataset_namestringRequired>=1 character
project_namestringOptional

Response

Dataset resource
namestring>=1 character
idstringformat: "uuid"
project_idstringformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

typeenum
Allowed values:
visibilityenum
Allowed values:
tagslist of strings
descriptionstringformat: "(?s)^\s*(\S.*\S|\S)\s*$"0-255 characters
created_atdatetimeRead-only
created_bystringRead-only
last_updated_atdatetimeRead-only
last_updated_bystringRead-only
experiment_countlongRead-only
dataset_items_countlongRead-only
optimization_countlongRead-only
most_recent_experiment_atdatetimeRead-only
last_created_experiment_atdatetimeRead-only
most_recent_optimization_atdatetimeRead-only
last_created_optimization_atdatetimeRead-only
statusenumRead-only
Allowed values:
latest_versionobjectRead-only
Summary of the latest dataset version