Create and execute experiment | Opik Documentation

POST/v1/private/experiments/executeCreate and execute experiment

Creates experiments for each prompt variant and asynchronously processes all dataset items

Request body

required

application/json

objectExperimentExecutionRequest

dataset_idstring · uuidrequired

dataset_namestringrequired

minLength 1

dataset_version_idstring · uuid

project_namestring

prompt_versionsarray of object

Show child attributes

Show array items

commitstring

idstring · uuidrequired

prompt_idstring · uuid

prompt_namestring

version_numberstring

sequential version number in the format v<N>; null for masks

promptsarray of objectrequired

minItems 1

Show child attributes

minItems 1

Show array items

configsobject

experiment_namestring

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

messagesarray of objectrequired

minItems 1

Show child attributes

minItems 1

Show array items

contentobjectrequired

rolestringrequired

minLength 1

modelstringrequired

minLength 1

prompt_versionsarray of object

Show child attributes

Items: PromptVersionLink ↑

version_hashstring

Example request

{
  "dataset_id": "00000000-0000-0000-0000-000000000000",
  "dataset_name": "string",
  "dataset_version_id": "00000000-0000-0000-0000-000000000000",
  "project_name": "string",
  "prompt_versions": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "prompts": [
    {
      "configs": {
        "additionalProp1": {}
      },
      "experiment_name": "string",
      "messages": [
        {
          "content": {},
          "role": "string"
        }
      ],
      "model": "string",
      "prompt_versions": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "version_hash": "string"
}

Responses

objectExperimentExecutionResponse

experimentsarray of object

Show child attributes

Show array items

experiment_idstring · uuid

prompt_indexinteger · int32

total_itemsinteger · int32

Example response

{
  "experiments": [
    {
      "experiment_id": "00000000-0000-0000-0000-000000000000",
      "prompt_index": 0
    }
  ],
  "total_items": 0
}

Examples

curl -X POST 'http://localhost:5173/api/v1/private/experiments/execute' \
  -H 'Content-Type: application/json' \
  -d '{"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"prompts":[{"configs":{"additionalProp1":{}},"experiment_name":"string","messages":[{"content":{},"role":"string"}],"model":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}]}],"version_hash":"string"}'

const response = await fetch('http://localhost:5173/api/v1/private/experiments/execute', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"prompts":[{"configs":{"additionalProp1":{}},"experiment_name":"string","messages":[{"content":{},"role":"string"}],"model":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}]}],"version_hash":"string"}),
});
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/experiments/execute', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"prompts\":[{\"configs\":{\"additionalProp1\":{}},\"experiment_name\":\"string\",\"messages\":[{\"content\":{},\"role\":\"string\"}],\"model\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}]}],\"version_hash\":\"string\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "http://localhost:5173/api/v1/private/experiments/execute",
    headers={"Content-Type": "application/json"},
    data='{"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"prompts":[{"configs":{"additionalProp1":{}},"experiment_name":"string","messages":[{"content":{},"role":"string"}],"model":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}]}],"version_hash":"string"}',
)
print(response.json())

package main

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

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"dataset_id":"00000000-0000-0000-0000-000000000000","dataset_name":"string","dataset_version_id":"00000000-0000-0000-0000-000000000000","project_name":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}],"prompts":[{"configs":{"additionalProp1":{}},"experiment_name":"string","messages":[{"content":{},"role":"string"}],"model":"string","prompt_versions":[{"id":"00000000-0000-0000-0000-000000000000"}]}],"version_hash":"string"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "http://localhost:5173/api/v1/private/experiments/execute", 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/execute");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"prompts\":[{\"configs\":{\"additionalProp1\":{}},\"experiment_name\":\"string\",\"messages\":[{\"content\":{},\"role\":\"string\"}],\"model\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}]}],\"version_hash\":\"string\"}");
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/execute"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"prompts\":[{\"configs\":{\"additionalProp1\":{}},\"experiment_name\":\"string\",\"messages\":[{\"content\":{},\"role\":\"string\"}],\"model\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}]}],\"version_hash\":\"string\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/experiments/execute")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"prompts\":[{\"configs\":{\"additionalProp1\":{}},\"experiment_name\":\"string\",\"messages\":[{\"content\":{},\"role\":\"string\"}],\"model\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}]}],\"version_hash\":\"string\"}"
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/execute");
request.Content = new StringContent("{\"dataset_id\":\"00000000-0000-0000-0000-000000000000\",\"dataset_name\":\"string\",\"dataset_version_id\":\"00000000-0000-0000-0000-000000000000\",\"project_name\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"prompts\":[{\"configs\":{\"additionalProp1\":{}},\"experiment_name\":\"string\",\"messages\":[{\"content\":{},\"role\":\"string\"}],\"model\":\"string\",\"prompt_versions\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}]}],\"version_hash\":\"string\"}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "experiments": [
    {
      "experiment_id": "00000000-0000-0000-0000-000000000000",
      "prompt_index": 0
    }
  ],
  "total_items": 0
}