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

Apply changes to dataset items

POST
/v1/private/datasets/:id/items/changes
POST
/api/v1/private/datasets/:id/items/changes
$curl -X POST http://localhost:5173/api/v1/private/datasets/id/items/changes \
> -H "Content-Type: application/json" \
> -d '{}'
1{
2 "id": "string",
3 "dataset_id": "string",
4 "version_hash": "string",
5 "tags": [
6 "string"
7 ],
8 "is_latest": true,
9 "version_name": "string",
10 "items_total": 1,
11 "items_added": 1,
12 "items_modified": 1,
13 "items_deleted": 1,
14 "change_description": "string",
15 "metadata": {},
16 "evaluators": [
17 {
18 "name": "string",
19 "type": "llm_judge",
20 "config": {}
21 }
22 ],
23 "execution_policy": {
24 "runs_per_item": 1,
25 "pass_threshold": 1
26 },
27 "created_at": "2024-01-15T09:30:00Z",
28 "created_by": "string",
29 "last_updated_at": "2024-01-15T09:30:00Z",
30 "last_updated_by": "string"
31}
Apply delta changes (add, edit, delete) to a dataset version with conflict detection. This endpoint: - Creates a new version with the applied changes - Validates that baseVersion matches the latest version (unless override=true) - Returns 409 Conflict if baseVersion is stale and override is not set Use `override=true` query parameter to force version creation even with stale baseVersion.
Was this page helpful?
Previous

Batch update dataset items

Next
Built with

Apply delta changes (add, edit, delete) to a dataset version with conflict detection.

This endpoint:

  • Creates a new version with the applied changes
  • Validates that baseVersion matches the latest version (unless override=true)
  • Returns 409 Conflict if baseVersion is stale and override is not set

Use override=true query parameter to force version creation even with stale baseVersion.

Path parameters

idstringRequiredformat: "uuid"

Query parameters

overridebooleanOptionalDefaults to false

Request

This endpoint expects an object.

Response

Version created successfully
idstringRead-onlyformat: "uuid"
dataset_idstringRead-onlyformat: "uuid"
version_hashstringRead-only
tagslist of stringsRead-only
is_latestbooleanRead-only
Indicates whether this is the latest version of the dataset
version_namestringRead-only
Sequential version name formatted as 'v1', 'v2', etc.
items_totalintegerRead-only
Total number of items in this version
items_addedintegerRead-only
Number of items added since last version
items_modifiedintegerRead-only
Number of items modified since last version
items_deletedintegerRead-only
Number of items deleted since last version
change_descriptionstringRead-only
metadatamap from strings to stringsRead-only
evaluatorslist of objectsRead-only
Default evaluators for items in this version
execution_policyobjectRead-only
Default execution policy for items in this version
created_atdatetimeRead-only
created_bystringRead-only
last_updated_atdatetimeRead-only
last_updated_bystringRead-only

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error