Stream dataset items | Opik Documentation

POST/v1/private/datasets/items/streamStream dataset items

Stream dataset items

Request body

application/json

objectDatasetItemStreamRequest

dataset_namestringrequired

minLength 1

dataset_versionstring

filtersstring

last_retrieved_idstring · uuid

project_namestring

steam_limitinteger · int32

maximum 2000 · minimum 1

Example request

{
  "dataset_name": "string",
  "dataset_version": "string",
  "filters": "string",
  "last_retrieved_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "steam_limit": 0
}

Responses

array of string

maxItems 2000

Show array items

anyOf · 2 options

Option 1objectDatasetItem

created_atstring · date-time

created_bystring

dataobjectrequired

dataset_idstring · uuid

dataset_item_idstring · uuid

Deprecated. Always equals 'id'. Retained for backward compatibility and will be removed in a future version

descriptionstring

pattern (?s)^\s*(\S.*\S|\S)\s*$

evaluatorsarray of object

Show child attributes

Show array items

configobjectrequired

namestringrequired

minLength 1

typestringrequired

one of "llm_judge", "code_metric"

execution_policyobject

Show child attributes

pass_thresholdinteger · int32

maximum 100 · minimum 1

runs_per_iteminteger · int32

maximum 100 · minimum 1

experiment_itemsarray of object

Show child attributes

Show array items

assertion_resultsarray of object

Show child attributes

Show array items

passedboolean

reasonstring

valuestring

commentsarray of object

Show child attributes

Show array items

created_atstring · date-time

created_bystring

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

source_queue_idstring · uuid

textstringrequired

minLength 1

created_atstring · date-time

created_bystring

dataset_item_idstring · uuidrequired

descriptionstring

durationnumber · double

execution_policyobjectExecutionPolicy ↑

experiment_idstring · uuidrequired

feedback_scoresarray of object

Show child attributes

Show array items

category_namestring

created_atstring · date-time

created_bystring

last_updated_atstring · date-time

last_updated_bystring

namestringrequired

minLength 1

reasonstring

sourcestringrequired

one of "ui", "sdk", "online_scoring"

source_queue_idstring · uuid

valuenumberrequired

maximum 1000000000 · minimum -1000000000

value_by_authorobject

idstring · uuid

inputobject

Show child attributes

anyOf · 3 options

Option 1object

Option 2array of object

Option 3string

last_updated_atstring · date-time

last_updated_bystring

outputobjectJsonListString ↑

project_idstring · uuid

project_namestring

pattern (?s)^\s*(\S.*\S|\S)\s*$

statusstring

one of "passed", "failed"

total_estimated_costnumber

trace_idstring · uuidrequired

trace_metadataobjectJsonListString ↑

trace_visibility_modestring

one of "default", "hidden"

usageobject

idstring · uuid

Stable item identifier. On write, used as the upsert key. If omitted, a new ID is generated. Remains the same across dataset versions

last_updated_atstring · date-time

last_updated_bystring

run_summaries_by_experimentobject

sourcestringrequired

one of "manual", "trace", "span", "sdk"

span_idstring · uuid

tagsarray of string

uniqueItems true

Show child attributes

uniqueItems true

trace_idstring · uuid

Option 2objectErrorMessage

codeinteger · int32

detailsstring

messagestring

Example response

[
  {
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "data": {},
    "dataset_id": "00000000-0000-0000-0000-000000000000",
    "dataset_item_id": "00000000-0000-0000-0000-000000000000",
    "description": "string",
    "evaluators": [
      {
        "config": {},
        "name": "string",
        "type": "code_metric"
      }
    ],
    "execution_policy": {
      "pass_threshold": 0,
      "runs_per_item": 0
    },
    "experiment_items": [
      {
        "assertion_results": [
          {
            "passed": true,
            "reason": "string",
            "value": "string"
          }
        ],
        "comments": [
          {
            "created_at": "2026-06-09T00:00:00Z",
            "created_by": "string",
            "id": "00000000-0000-0000-0000-000000000000",
            "last_updated_at": "2026-06-09T00:00:00Z",
            "last_updated_by": "string",
            "source_queue_id": "00000000-0000-0000-0000-000000000000",
            "text": "string"
          }
        ],
        "created_at": "2026-06-09T00:00:00Z",
        "created_by": "string",
        "dataset_item_id": "00000000-0000-0000-0000-000000000000",
        "description": "string",
        "duration": 0,
        "execution_policy": {
          "pass_threshold": 0,
          "runs_per_item": 0
        },
        "experiment_id": "00000000-0000-0000-0000-000000000000",
        "feedback_scores": [
          {
            "category_name": "string",
            "created_at": "2026-06-09T00:00:00Z",
            "created_by": "string",
            "last_updated_at": "2026-06-09T00:00:00Z",
            "last_updated_by": "string",
            "name": "string",
            "reason": "string",
            "source": "online_scoring",
            "source_queue_id": "00000000-0000-0000-0000-000000000000",
            "value": 0,
            "value_by_author": {
              "additionalProp1": {
                "author": "string",
                "category_name": "string",
                "last_updated_at": "2026-06-09T00:00:00Z",
                "reason": "string",
                "source": "online_scoring",
                "source_queue_id": "string",
                "span_id": "string",
                "span_type": "string",
                "value": 0
              }
            }
          }
        ],
        "id": "00000000-0000-0000-0000-000000000000",
        "input": [
          {}
        ],
        "last_updated_at": "2026-06-09T00:00:00Z",
        "last_updated_by": "string",
        "output": [
          {}
        ],
        "project_id": "00000000-0000-0000-0000-000000000000",
        "project_name": "string",
        "status": "failed",
        "total_estimated_cost": 0,
        "trace_id": "00000000-0000-0000-0000-000000000000",
        "trace_metadata": [
          {}
        ],
        "trace_visibility_mode": "default",
        "usage": {
          "additionalProp1": 0
        }
      }
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "last_updated_at": "2026-06-09T00:00:00Z",
    "last_updated_by": "string",
    "run_summaries_by_experiment": {
      "additionalProp1": {
        "passed_runs": 0,
        "status": "failed"
      }
    },
    "source": "manual"
  }
]

Examples

curl -X POST 'http://localhost:5173/api/v1/private/datasets/items/stream' \
  -H 'Content-Type: application/json' \
  -d '{"dataset_name":"string","dataset_version":"string","filters":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","project_name":"string","steam_limit":0}'

const response = await fetch('http://localhost:5173/api/v1/private/datasets/items/stream', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"dataset_name":"string","dataset_version":"string","filters":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","project_name":"string","steam_limit":0}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/datasets/items/stream', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"dataset_name\":\"string\",\"dataset_version\":\"string\",\"filters\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"steam_limit\":0}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/datasets/items/stream",
    headers={"Content-Type": "application/json"},
    data='{"dataset_name":"string","dataset_version":"string","filters":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","project_name":"string","steam_limit":0}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"dataset_name":"string","dataset_version":"string","filters":"string","last_retrieved_id":"00000000-0000-0000-0000-000000000000","project_name":"string","steam_limit":0}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/datasets/items/stream", 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/stream");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"dataset_name\":\"string\",\"dataset_version\":\"string\",\"filters\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"steam_limit\":0}");
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/stream"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"dataset_name\":\"string\",\"dataset_version\":\"string\",\"filters\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"steam_limit\":0}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/datasets/items/stream")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"dataset_name\":\"string\",\"dataset_version\":\"string\",\"filters\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"steam_limit\":0}"
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/stream");
request.Content = new StringContent("{\"dataset_name\":\"string\",\"dataset_version\":\"string\",\"filters\":\"string\",\"last_retrieved_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"steam_limit\":0}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

[
  {
    "created_at": "2026-06-09T00:00:00Z",
    "created_by": "string",
    "data": {},
    "dataset_id": "00000000-0000-0000-0000-000000000000",
    "dataset_item_id": "00000000-0000-0000-0000-000000000000",
    "description": "string",
    "evaluators": [
      {
        "config": {},
        "name": "string",
        "type": "code_metric"
      }
    ],
    "execution_policy": {
      "pass_threshold": 0,
      "runs_per_item": 0
    },
    "experiment_items": [
      {
        "assertion_results": [
          {
            "passed": true,
            "reason": "string",
            "value": "string"
          }
        ],
        "comments": [
          {
            "created_at": "2026-06-09T00:00:00Z",
            "created_by": "string",
            "id": "00000000-0000-0000-0000-000000000000",
            "last_updated_at": "2026-06-09T00:00:00Z",
            "last_updated_by": "string",
            "source_queue_id": "00000000-0000-0000-0000-000000000000",
            "text": "string"
          }
        ],
        "created_at": "2026-06-09T00:00:00Z",
        "created_by": "string",
        "dataset_item_id": "00000000-0000-0000-0000-000000000000",
        "description": "string",
        "duration": 0,
        "execution_policy": {
          "pass_threshold": 0,
          "runs_per_item": 0
        },
        "experiment_id": "00000000-0000-0000-0000-000000000000",
        "feedback_scores": [
          {
            "category_name": "string",
            "created_at": "2026-06-09T00:00:00Z",
            "created_by": "string",
            "last_updated_at": "2026-06-09T00:00:00Z",
            "last_updated_by": "string",
            "name": "string",
            "reason": "string",
            "source": "online_scoring",
            "source_queue_id": "00000000-0000-0000-0000-000000000000",
            "value": 0,
            "value_by_author": {
              "additionalProp1": {
                "author": "string",
                "category_name": "string",
                "last_updated_at": "2026-06-09T00:00:00Z",
                "reason": "string",
                "source": "online_scoring",
                "source_queue_id": "string",
                "span_id": "string",
                "span_type": "string",
                "value": 0
              }
            }
          }
        ],
        "id": "00000000-0000-0000-0000-000000000000",
        "input": [
          {}
        ],
        "last_updated_at": "2026-06-09T00:00:00Z",
        "last_updated_by": "string",
        "output": [
          {}
        ],
        "project_id": "00000000-0000-0000-0000-000000000000",
        "project_name": "string",
        "status": "failed",
        "total_estimated_cost": 0,
        "trace_id": "00000000-0000-0000-0000-000000000000",
        "trace_metadata": [
          {}
        ],
        "trace_visibility_mode": "default",
        "usage": {
          "additionalProp1": 0
        }
      }
    ],
    "id": "00000000-0000-0000-0000-000000000000",
    "last_updated_at": "2026-06-09T00:00:00Z",
    "last_updated_by": "string",
    "run_summaries_by_experiment": {
      "additionalProp1": {
        "passed_runs": 0,
        "status": "failed"
      }
    },
    "source": "manual"
  }
]