Delete dataset items | Opik Documentation

POST/v1/private/datasets/items/deleteDelete dataset items

Delete dataset items using one of two modes:

Delete by IDs: Provide 'item_ids' to delete specific items by their IDs
Delete by filters: Provide 'dataset_id' with optional 'filters' to delete items matching criteria

When using filters, an empty 'filters' array will delete all items in the specified dataset.

Request body

application/json

objectDatasetItemsDelete

Request to delete multiple dataset items

batch_group_idstring · uuid

Optional batch group ID to group multiple delete operations into a single dataset version. If null, mutates the latest version instead of creating a new one.

dataset_idstring · uuid

Dataset ID to scope the deletion. Required when using 'filters'. Mutually exclusive with 'item_ids'.

filtersarray of object

Filters to select dataset items to delete within the specified dataset. Must be used with 'dataset_id'. Mutually exclusive with 'item_ids'. Empty array means 'delete all items in the dataset'.

Show child attributes

Show array items

Filters to select dataset items to delete within the specified dataset. Must be used with 'dataset_id'. Mutually exclusive with 'item_ids'. Empty array means 'delete all items in the dataset'.

fieldstring

keystring

operatorstring

one of "contains", "not_contains", "starts_with", "ends_with", "=", "!=", ">", ">=", "<", "<=", "is_empty", "is_not_empty", "in", "not_in"

valuestring

item_idsarray of string · uuid

List of dataset item IDs to delete (max 1000). Use this to delete specific items by their IDs. Mutually exclusive with 'dataset_id' and 'filters'.

maxItems 1000 · minItems 1 · uniqueItems true

Show child attributes

maxItems 1000 · minItems 1 · uniqueItems true

Example request

{
  "batch_group_id": "00000000-0000-0000-0000-000000000000",
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "filters": [
    {
      "field": "string",
      "key": "string",
      "operator": "!=",
      "value": "string"
    }
  ],
  "item_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Responses

Examples

curl -X POST 'http://localhost:5173/api/v1/private/datasets/items/delete' \
  -H 'Content-Type: application/json' \
  -d '{"batch_group_id":"00000000-0000-0000-0000-000000000000","dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"item_ids":["00000000-0000-0000-0000-000000000000"]}'

const response = await fetch('http://localhost:5173/api/v1/private/datasets/items/delete', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"batch_group_id":"00000000-0000-0000-0000-000000000000","dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"item_ids":["00000000-0000-0000-0000-000000000000"]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/datasets/items/delete', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"batch_group_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"item_ids\":[\"00000000-0000-0000-0000-000000000000\"]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/datasets/items/delete",
    headers={"Content-Type": "application/json"},
    data='{"batch_group_id":"00000000-0000-0000-0000-000000000000","dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"item_ids":["00000000-0000-0000-0000-000000000000"]}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"batch_group_id":"00000000-0000-0000-0000-000000000000","dataset_id":"00000000-0000-0000-0000-000000000000","filters":[{"field":"string","key":"string","operator":"!=","value":"string"}],"item_ids":["00000000-0000-0000-0000-000000000000"]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/datasets/items/delete", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/datasets/items/delete");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"batch_group_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"item_ids\":[\"00000000-0000-0000-0000-000000000000\"]}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/datasets/items/delete"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"batch_group_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"item_ids\":[\"00000000-0000-0000-0000-000000000000\"]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/datasets/items/delete")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"batch_group_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"item_ids\":[\"00000000-0000-0000-0000-000000000000\"]}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost:5173/api/v1/private/datasets/items/delete");
request.Content = new StringContent("{\"batch_group_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"filters\":[{\"field\":\"string\",\"key\":\"string\",\"operator\":\"!=\",\"value\":\"string\"}],\"item_ids\":[\"00000000-0000-0000-0000-000000000000\"]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)