Skip to main content
POST
/
v1
/
datasets
/
{dataset_id}
/
experiments
Create experiment on a dataset
curl --request POST \
  --url https://api.example.com/v1/datasets/{dataset_id}/experiments \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "metadata": {},
  "version_id": "<string>",
  "splits": [
    "<string>"
  ],
  "repetitions": 1
}
'
{
  "data": {
    "id": "<string>",
    "dataset_id": "<string>",
    "dataset_version_id": "<string>",
    "repetitions": 123,
    "metadata": {},
    "project_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "example_count": 123,
    "successful_run_count": 123,
    "failed_run_count": 123,
    "missing_run_count": 123
  }
}

Path Parameters

​
dataset_id
string
required

Body

application/json

Details of the experiment to be created

​
name
string | null

Name of the experiment (if omitted, a random name will be generated)

​
description
string | null

An optional description of the experiment

​
metadata
Metadata · object

Metadata for the experiment

​
version_id
string | null

ID of the dataset version over which the experiment will be run (if omitted, the latest version will be used)

​
splits
string[] | null

List of dataset split identifiers (GlobalIDs or names) to filter by

​
repetitions
integer
default:1

Number of times the experiment should be repeated for each example

Response

Experiment retrieved successfully

​
data
Experiment · object
required