TypeScript APIPython APICommunityGitHubPhoenix Cloud

Experiments

REST API methods for interacting with Phoenix experiments

List experiments by dataset

get
Path parameters
dataset_idstringRequired
Responses
200
Experiments retrieved successfully
application/json
get
GET /v1/datasets/{dataset_id}/experiments HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "id": "text",
      "dataset_id": "text",
      "dataset_version_id": "text",
      "repetitions": 1,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "project_name": "text",
      "created_at": "2025-06-15T02:12:26.499Z",
      "updated_at": "2025-06-15T02:12:26.499Z"
    }
  ]
}

Create experiment on a dataset

post
Path parameters
dataset_idstringRequired
Body

Details of the experiment to be created

nameany ofOptional

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

stringOptional
or
nullOptional
descriptionany ofOptional

An optional description of the experiment

stringOptional
or
nullOptional
metadataany ofOptional

Metadata for the experiment

or
nullOptional
version_idany ofOptional

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

stringOptional
or
nullOptional
repetitionsintegerOptional

Number of times the experiment should be repeated for each example

Default: 1
Responses
200
Experiment retrieved successfully
application/json
post
POST /v1/datasets/{dataset_id}/experiments HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "name": "text",
  "description": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "version_id": "text",
  "repetitions": 1
}
{
  "data": {
    "id": "text",
    "dataset_id": "text",
    "dataset_version_id": "text",
    "repetitions": 1,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "project_name": "text",
    "created_at": "2025-06-15T02:12:26.499Z",
    "updated_at": "2025-06-15T02:12:26.499Z"
  }
}

Get experiment by ID

get
Path parameters
experiment_idstringRequired
Responses
200
Experiment retrieved successfully
application/json
get
GET /v1/experiments/{experiment_id} HTTP/1.1
Host: 
Accept: */*

{
  "data": {
    "id": "text",
    "dataset_id": "text",
    "dataset_version_id": "text",
    "repetitions": 1,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "project_name": "text",
    "created_at": "2025-06-15T02:12:26.499Z",
    "updated_at": "2025-06-15T02:12:26.499Z"
  }
}

Download experiment runs as a JSON file

get
Path parameters
experiment_idstringRequired
Responses
200
Successful Response
text/plain
Responsestring
get
GET /v1/experiments/{experiment_id}/json HTTP/1.1
Host: 
Accept: */*

text

Download experiment runs as a CSV file

get
Path parameters
experiment_idstringRequired
Responses
200
Successful Response
Responseany
get
GET /v1/experiments/{experiment_id}/csv HTTP/1.1
Host: 
Accept: */*

No content
PreviousDatasetsNextSpans

Last updated

Was this helpful?