v1

latestOpenAPI 3.1.02026-07-1320186461.3 KB

Create Experiment Api

Create an experiment and get the associated experiment uuid.

post/api/parea/v1/experiment

Request body

namestring required

Name of the experiment

run_namestring nullable

Name of the run. Must be unique for each experiment and can only contain alphanumeric characters, hyphens, and underscores.

project_uuidstring required

UUID of the project associated with this experiment

is_publicboolean

If experiment should be public

metadataobject nullable

Any additional key-value pairs which provide context or are useful for filtering.

Example request

{
  "metadata": {
    "dataset": "dev 123"
  },
  "name": "Test Experiment",
  "project_uuid": "...",
  "run_name": "test-experiment"
}

Response

Successful Response

namestring required

Name of the experiment

run_namestring nullable

Name of the run. Must be unique for each experiment and can only contain alphanumeric characters, hyphens, and underscores.

project_uuidstring required

UUID of the project associated with this experiment

is_publicboolean

If experiment should be public

metadataobject nullable

Any additional key-value pairs which provide context or are useful for filtering.

uuidstring required

UUID of the created experiment

created_atstring required

Timestamp the experiment was created

Example response

{
  "created_at": "2024-05-30 13:48:34",
  "metadata": {
    "dataset": "dev 123"
  },
  "name": "Test Experiment",
  "project_uuid": "...",
  "run_name": "test-experiment",
  "uuid": "..."
}