Skip to main content
POST
/
api
/
experiment
Create Experiment
curl --request POST \
  --url https://api.trieve.ai/api/experiment \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "experiment_config": {
    "area": "<string>",
    "control_name": "<string>",
    "control_split": 123,
    "t1_name": "<string>",
    "t1_split": 123
  },
  "name": "<string>"
}
'
import requests

url = "https://api.trieve.ai/api/experiment"

payload = {
"experiment_config": {
"area": "<string>",
"control_name": "<string>",
"control_split": 123,
"t1_name": "<string>",
"t1_split": 123
},
"name": "<string>"
}
headers = {
"TR-Dataset": "<tr-dataset>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'TR-Dataset': '<tr-dataset>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
experiment_config: {
area: '<string>',
control_name: '<string>',
control_split: 123,
t1_name: '<string>',
t1_split: 123
},
name: '<string>'
})
};

fetch('https://api.trieve.ai/api/experiment', 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.trieve.ai/api/experiment",
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([
'experiment_config' => [
'area' => '<string>',
'control_name' => '<string>',
'control_split' => 123,
't1_name' => '<string>',
't1_split' => 123
],
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Dataset: <tr-dataset>"
],
]);

$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.trieve.ai/api/experiment"

payload := strings.NewReader("{\n \"experiment_config\": {\n \"area\": \"<string>\",\n \"control_name\": \"<string>\",\n \"control_split\": 123,\n \"t1_name\": \"<string>\",\n \"t1_split\": 123\n },\n \"name\": \"<string>\"\n}")

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

req.Header.Add("TR-Dataset", "<tr-dataset>")
req.Header.Add("Authorization", "<api-key>")
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.trieve.ai/api/experiment")
.header("TR-Dataset", "<tr-dataset>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"experiment_config\": {\n \"area\": \"<string>\",\n \"control_name\": \"<string>\",\n \"control_split\": 123,\n \"t1_name\": \"<string>\",\n \"t1_split\": 123\n },\n \"name\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.trieve.ai/api/experiment")

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

request = Net::HTTP::Post.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"experiment_config\": {\n \"area\": \"<string>\",\n \"control_name\": \"<string>\",\n \"control_split\": 123,\n \"t1_name\": \"<string>\",\n \"t1_split\": 123\n },\n \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "area": "<string>",
  "control_name": "<string>",
  "control_split": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "t1_name": "<string>",
  "t1_split": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"message": "Bad Request"
}

Authorizations

Authorization
string
header
required

Headers

TR-Dataset
string<uuid>
required

The dataset id to use for the request

Body

application/json

JSON request payload to create a new experiment

experiment_config
object
required
name
string
required

Response

Experiment created successfully

area
string
required
control_name
string
required
control_split
number<float>
required
created_at
string<date-time>
required
dataset_id
string<uuid>
required
id
string<uuid>
required
name
string
required
t1_name
string
required
t1_split
number<float>
required
updated_at
string<date-time>
required