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>"
}
'
{
  "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"
}

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