Experiments

REST API methods for interacting with Phoenix experiments

PreviousDatasets NextSpans

Last updated 22 hours ago

Was this helpful?

Get experiment by ID

get

Path parameters

experiment_idstringRequired

Responses

application/json

objectOptional

text/plain

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-04-19T17:41:42.617Z",
    "updated_at": "2025-04-19T17:41:42.617Z"
  }
}

Download experiment runs as a JSON file

get

Path parameters

experiment_idstringRequired

Responses

text/plain

stringOptional

text/plain

application/json

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

anyOptional

text/plain

application/json

get

GET /v1/experiments/{experiment_id}/csv HTTP/1.1
Host: 
Accept: */*

No content

List experiments by dataset

get

Path parameters

dataset_idstringRequired

Responses

application/json

objectOptional

text/plain

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-04-19T17:41:42.617Z",
      "updated_at": "2025-04-19T17:41:42.617Z"
    }
  ]
}

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)

descriptionany ofOptional

An optional description of the experiment

metadataany ofOptional

Metadata for the experiment

version_idany ofOptional

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

repetitionsintegerOptional

Number of times the experiment should be repeated for each example

Default: 1

Responses

application/json

objectOptional

text/plain

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-04-19T17:41:42.617Z",
    "updated_at": "2025-04-19T17:41:42.617Z"
  }
}