Skip to main content
Opik Documentation

Search documentation

Type to search this documentation.

Get dataset by id

GET/v1/private/datasets/{id}Get dataset by id

Get dataset by id

Parameters

idstring · uuidpathrequired

Responses

200Dataset resourceapplication/json
objectDataset_Public
created_atstring · date-time
created_bystring
dataset_items_countinteger · int64
descriptionstring

maxLength 255 · minLength 0 · pattern (?s)^\s*(\S.*\S|\S)\s*$

experiment_countinteger · int64
idstring · uuid
last_created_experiment_atstring · date-time
last_created_optimization_atstring · date-time
last_updated_atstring · date-time
last_updated_bystring
latest_versionobject

Summary of the latest dataset version

Show child attributes
change_descriptionstring

Description of changes in this version

idstring · uuid

Unique identifier of the version

tagsarray of string

Tags associated with this version

uniqueItems true

Show child attributes

uniqueItems true

version_hashstring

Hash of the version content

version_namestring

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

most_recent_experiment_atstring · date-time
most_recent_optimization_atstring · date-time
namestringrequired

minLength 1

optimization_countinteger · int64
project_idstring · uuid

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

statusstring

one of "unknown", "processing", "completed", "failed"

tagsarray of string

uniqueItems true

Show child attributes

uniqueItems true

typestring

one of "dataset", "evaluation_suite"

visibilitystring

one of "private", "public"

Example response
{
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "dataset_items_count": 0,
  "description": "string",
  "experiment_count": 0,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_created_experiment_at": "2026-06-09T00:00:00Z",
  "last_created_optimization_at": "2026-06-09T00:00:00Z",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "latest_version": {
    "change_description": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "tags": [
      "string"
    ],
    "version_hash": "string",
    "version_name": "string"
  },
  "most_recent_experiment_at": "2026-06-09T00:00:00Z",
  "most_recent_optimization_at": "2026-06-09T00:00:00Z",
  "name": "string",
  "optimization_count": 0,
  "project_id": "00000000-0000-0000-0000-000000000000",
  "status": "completed",
  "tags": [
    "string"
  ],
  "type": "dataset",
  "visibility": "private"
}
Documentation menu