Create experiment | Opik Documentation

POST/v1/private/experimentsCreate experiment

Create experiment

Request body

application/json

objectExperiment_Write

dataset_namenull | stringrequired

minLength 1

dataset_version_idstring · uuid

ID of the dataset version this experiment is linked to. If not provided at creation, experiment will be automatically linked to the latest version.

evaluation_methodstring

one of "dataset", "evaluation_suite"

experiment_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

idstring · uuid

metadataobject

Show child attributes

anyOf · 3 options

Option 1object

Option 2array of object

Option 3string

namestring

optimization_idstring · uuid

project_idstring · uuid

Project ID. Takes precedence over project_name when both are provided.

project_namestring

Project name. Creates project if it doesn't exist. Ignored when project_id is provided.

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

prompt_versionobject

Show child attributes

idstring · uuidrequired

prompt_versionsarray of object

Show child attributes

Items: PromptVersionLink_Write ↑

statusstring

one of "running", "completed", "cancelled"

tagsarray of string

maxItems 50 · minItems 0 · uniqueItems true

Show child attributes

maxItems 50 · minItems 0 · uniqueItems true

typestring

one of "regular", "trial", "mini-batch", "mutation"

Example request

{
  "dataset_name": "string",
  "dataset_version_id": "00000000-0000-0000-0000-000000000000",
  "evaluation_method": "dataset",
  "experiment_scores": [
    {
      "name": "string",
      "value": 0
    }
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "metadata": {},
  "name": "string",
  "optimization_id": "00000000-0000-0000-0000-000000000000",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "prompt_version": {
    "id": "00000000-0000-0000-0000-000000000000"
  },
  "prompt_versions": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "status": "cancelled",
  "tags": [
    "string"
  ],
  "type": "mini-batch"
}

Responses

Headers

Location

Examples

curl -X POST 'http://localhost:5173/api/v1/private/experiments' \
  -H 'Content-Type: application/json' \
  -d '{"dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","evaluation_method":"dataset","experiment_scores":[{"name":"string","value":0}],"id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","optimization_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_version":{"id":"00000000-0000-0000-0000-000000000000"},"prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"status":"cancelled","tags":["string"],"type":"mini-batch"}'

const response = await fetch('http://localhost:5173/api/v1/private/experiments', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","evaluation_method":"dataset","experiment_scores":[{"name":"string","value":0}],"id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","optimization_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_version":{"id":"00000000-0000-0000-0000-000000000000"},"prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"status":"cancelled","tags":["string"],"type":"mini-batch"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/experiments', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"evaluation_method\":\"dataset\",\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"optimization_id\":\"00000000-0000-0000-0000-000000000000\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_version\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"status\":\"cancelled\",\"tags\":[\"string\"],\"type\":\"mini-batch\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/experiments",
    headers={"Content-Type": "application/json"},
    data='{"dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","evaluation_method":"dataset","experiment_scores":[{"name":"string","value":0}],"id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","optimization_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_version":{"id":"00000000-0000-0000-0000-000000000000"},"prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"status":"cancelled","tags":["string"],"type":"mini-batch"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","evaluation_method":"dataset","experiment_scores":[{"name":"string","value":0}],"id":"00000000-0000-0000-0000-000000000000","metadata":{},"name":"string","optimization_id":"00000000-0000-0000-0000-000000000000","project_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_version":{"id":"00000000-0000-0000-0000-000000000000"},"prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"status":"cancelled","tags":["string"],"type":"mini-batch"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/experiments", 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");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"evaluation_method\":\"dataset\",\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"optimization_id\":\"00000000-0000-0000-0000-000000000000\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_version\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"status\":\"cancelled\",\"tags\":[\"string\"],\"type\":\"mini-batch\"}");
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"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"evaluation_method\":\"dataset\",\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"optimization_id\":\"00000000-0000-0000-0000-000000000000\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_version\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"status\":\"cancelled\",\"tags\":[\"string\"],\"type\":\"mini-batch\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/experiments")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"evaluation_method\":\"dataset\",\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"optimization_id\":\"00000000-0000-0000-0000-000000000000\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_version\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"status\":\"cancelled\",\"tags\":[\"string\"],\"type\":\"mini-batch\"}"
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");
request.Content = new StringContent("{\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"evaluation_method\":\"dataset\",\"experiment_scores\":[{\"name\":\"string\",\"value\":0}],\"id\":\"00000000-0000-0000-0000-000000000000\",\"metadata\":{},\"name\":\"string\",\"optimization_id\":\"00000000-0000-0000-0000-000000000000\",\"project_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_version\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"status\":\"cancelled\",\"tags\":[\"string\"],\"type\":\"mini-batch\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

(no response body — HTTP 201)