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 item by id

GET
/v1/private/datasets/items/:itemId
GET
/api/v1/private/datasets/items/:itemId
$curl http://localhost:5173/api/v1/private/datasets/items/itemId
200Retrieved
1{
2  "source": "manual",
3  "data": {},
4  "id": "string",
5  "dataset_item_id": "string",
6  "trace_id": "string",
7  "span_id": "string",
8  "description": "string",
9  "tags": [
10    "string"
11  ],
12  "evaluators": [
13    {
14      "name": "string",
15      "type": "llm_judge",
16      "config": {}
17    }
18  ],
19  "execution_policy": {
20    "runs_per_item": 1,
21    "pass_threshold": 1
22  },
23  "experiment_items": [
24    {
25      "experiment_id": "string",
26      "dataset_item_id": "string",
27      "trace_id": "string",
28      "id": "string",
29      "project_id": "string",
30      "created_at": "2024-01-15T09:30:00Z",
31      "last_updated_at": "2024-01-15T09:30:00Z",
32      "created_by": "string",
33      "last_updated_by": "string",
34      "trace_visibility_mode": "default"
35    }
36  ],
37  "run_summaries_by_experiment": {},
38  "dataset_id": "string",
39  "created_at": "2024-01-15T09:30:00Z",
40  "last_updated_at": "2024-01-15T09:30:00Z",
41  "created_by": "string",
42  "last_updated_by": "string"
43}
Get dataset item by id
Was this page helpful?
Previous

Partially update dataset item by id

Next
Built with

Path parameters

itemIdstringRequiredformat: "uuid"

Response

Dataset item resource
sourceenum
Allowed values:
dataobject
idstringformat: "uuid"
Stable item identifier. On write, used as the upsert key. If omitted, a new ID is generated. Remains the same across dataset versions
dataset_item_idstringRead-onlyformat: "uuid"
Deprecated. Always equals 'id'. Retained for backward compatibility and will be removed in a future version
trace_idstringformat: "uuid"
span_idstringformat: "uuid"
descriptionstringformat: "(?s)^\s*(\S.*\S|\S)\s*$"
tagslist of strings
evaluatorslist of objects
execution_policyobjectRead-only
Default execution policy for items in this version
experiment_itemslist of objectsRead-only
run_summaries_by_experimentmap from strings to objectsRead-only
dataset_idstringRead-onlyformat: "uuid"
created_atdatetimeRead-only
last_updated_atdatetimeRead-only
created_bystringRead-only
last_updated_bystringRead-only