Create experiment items | Opik Documentation

POST/v1/private/experiments/itemsCreate experiment items

Create experiment items

Request body

application/json

objectExperimentItemsBatch

experiment_itemsarray of objectrequired

maxItems 1000 · minItems 1 · uniqueItems true

Show child attributes

maxItems 1000 · minItems 1 · uniqueItems true

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_policyobject

Show child attributes

pass_thresholdinteger · int32

maximum 100 · minimum 1

runs_per_iteminteger · int32

maximum 100 · minimum 1

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

Example request

{
  "experiment_items": [
    {
      "dataset_item_id": "00000000-0000-0000-0000-000000000000",
      "execution_policy": {
        "pass_threshold": 0,
        "runs_per_item": 0
      },
      "experiment_id": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "input": {},
      "output": {},
      "project_name": "string",
      "trace_id": "00000000-0000-0000-0000-000000000000",
      "trace_metadata": {}
    }
  ]
}

Responses

Examples

curl -X POST 'http://localhost:5173/api/v1/private/experiments/items' \
  -H 'Content-Type: application/json' \
  -d '{"experiment_items":[{"dataset_item_id":"00000000-0000-0000-0000-000000000000","execution_policy":{"pass_threshold":0,"runs_per_item":0},"experiment_id":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000","input":{},"output":{},"project_name":"string","trace_id":"00000000-0000-0000-0000-000000000000","trace_metadata":{}}]}'

const response = await fetch('http://localhost:5173/api/v1/private/experiments/items', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"experiment_items":[{"dataset_item_id":"00000000-0000-0000-0000-000000000000","execution_policy":{"pass_threshold":0,"runs_per_item":0},"experiment_id":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000","input":{},"output":{},"project_name":"string","trace_id":"00000000-0000-0000-0000-000000000000","trace_metadata":{}}]}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/experiments/items', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"experiment_items\":[{\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"experiment_id\":\"00000000-0000-0000-0000-000000000000\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"input\":{},\"output\":{},\"project_name\":\"string\",\"trace_id\":\"00000000-0000-0000-0000-000000000000\",\"trace_metadata\":{}}]}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/experiments/items",
    headers={"Content-Type": "application/json"},
    data='{"experiment_items":[{"dataset_item_id":"00000000-0000-0000-0000-000000000000","execution_policy":{"pass_threshold":0,"runs_per_item":0},"experiment_id":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000","input":{},"output":{},"project_name":"string","trace_id":"00000000-0000-0000-0000-000000000000","trace_metadata":{}}]}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"experiment_items":[{"dataset_item_id":"00000000-0000-0000-0000-000000000000","execution_policy":{"pass_threshold":0,"runs_per_item":0},"experiment_id":"00000000-0000-0000-0000-000000000000","id":"00000000-0000-0000-0000-000000000000","input":{},"output":{},"project_name":"string","trace_id":"00000000-0000-0000-0000-000000000000","trace_metadata":{}}]}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/experiments/items", 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/experiments/items");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"experiment_items\":[{\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"experiment_id\":\"00000000-0000-0000-0000-000000000000\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"input\":{},\"output\":{},\"project_name\":\"string\",\"trace_id\":\"00000000-0000-0000-0000-000000000000\",\"trace_metadata\":{}}]}");
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/experiments/items"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"experiment_items\":[{\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"experiment_id\":\"00000000-0000-0000-0000-000000000000\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"input\":{},\"output\":{},\"project_name\":\"string\",\"trace_id\":\"00000000-0000-0000-0000-000000000000\",\"trace_metadata\":{}}]}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/experiments/items")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"experiment_items\":[{\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"experiment_id\":\"00000000-0000-0000-0000-000000000000\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"input\":{},\"output\":{},\"project_name\":\"string\",\"trace_id\":\"00000000-0000-0000-0000-000000000000\",\"trace_metadata\":{}}]}"
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/experiments/items");
request.Content = new StringContent("{\"experiment_items\":[{\"dataset_item_id\":\"00000000-0000-0000-0000-000000000000\",\"execution_policy\":{\"pass_threshold\":0,\"runs_per_item\":0},\"experiment_id\":\"00000000-0000-0000-0000-000000000000\",\"id\":\"00000000-0000-0000-0000-000000000000\",\"input\":{},\"output\":{},\"project_name\":\"string\",\"trace_id\":\"00000000-0000-0000-0000-000000000000\",\"trace_metadata\":{}}]}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 204)