Get dataset by id | Opik Documentation

curl http://localhost:5173/api/v1/private/datasets/id \
     -H "Content-Type: application/json"

{
  "name": "ImageNet Sample Dataset",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "type": "dataset",
  "visibility": "private",
  "tags": [
    "image-classification",
    "benchmark"
  ],
  "description": "A subset of the ImageNet dataset for benchmarking image classification models.",
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "alice@example.com",
  "last_updated_at": "2024-04-10T14:45:00Z",
  "last_updated_by": "bob@example.com",
  "experiment_count": 42,
  "dataset_items_count": 10000,
  "optimization_count": 5,
  "most_recent_experiment_at": "2024-04-09T16:20:00Z",
  "last_created_experiment_at": "2024-04-09T16:20:00Z",
  "most_recent_optimization_at": "2024-04-08T11:00:00Z",
  "last_created_optimization_at": "2024-04-08T11:00:00Z",
  "status": "completed",
  "latest_version": {
    "id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
    "version_hash": "a3f5c9d8e7b4f2a1c6d8e9f0b1a2c3d4",
    "version_name": "v3",
    "change_description": "Added 2000 new labeled images and fixed label inconsistencies.",
    "tags": [
      "v3",
      "augmented"
    ]
  }
}

Get dataset by id

Path parameters

idstringRequiredformat: "uuid"

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