Skip to main content
POST
/
v1
/
experiments
/
{experiment_id}
/
runs
Create run for an experiment
curl --request POST \
  --url https://api.example.com/v1/experiments/{experiment_id}/runs \
  --header 'Content-Type: application/json' \
  --data '
{
  "dataset_example_id": "<string>",
  "output": "<unknown>",
  "repetition_number": 123,
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "trace_id": "<string>",
  "error": "<string>"
}
'
import requests

url = "https://api.example.com/v1/experiments/{experiment_id}/runs"

payload = {
"dataset_example_id": "<string>",
"output": "<unknown>",
"repetition_number": 123,
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"trace_id": "<string>",
"error": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
dataset_example_id: '<string>',
output: '<unknown>',
repetition_number: 123,
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
trace_id: '<string>',
error: '<string>'
})
};

fetch('https://api.example.com/v1/experiments/{experiment_id}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/experiments/{experiment_id}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dataset_example_id' => '<string>',
'output' => '<unknown>',
'repetition_number' => 123,
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'trace_id' => '<string>',
'error' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/experiments/{experiment_id}/runs"

payload := strings.NewReader("{\n \"dataset_example_id\": \"<string>\",\n \"output\": \"<unknown>\",\n \"repetition_number\": 123,\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"trace_id\": \"<string>\",\n \"error\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v1/experiments/{experiment_id}/runs")
.header("Content-Type", "application/json")
.body("{\n \"dataset_example_id\": \"<string>\",\n \"output\": \"<unknown>\",\n \"repetition_number\": 123,\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"trace_id\": \"<string>\",\n \"error\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/experiments/{experiment_id}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataset_example_id\": \"<string>\",\n \"output\": \"<unknown>\",\n \"repetition_number\": 123,\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"trace_id\": \"<string>\",\n \"error\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>"
  }
}
"<string>"
"<string>"
"<string>"
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Path Parameters

experiment_id
string
required

Body

application/json
dataset_example_id
string
required

The ID of the dataset example used in the experiment run

output
any
required

The output of the experiment task

repetition_number
integer
required

The repetition number of the experiment run

start_time
string<date-time>
required

The start time of the experiment run

end_time
string<date-time>
required

The end time of the experiment run

trace_id
string | null

The ID of the corresponding trace (if one exists)

error
string | null

Optional error message if the experiment run encountered an error

Response

Experiment run created successfully

data
CreateExperimentRunResponseBodyData · object
required