Skip to main content
POST
/
api
/
parea
/
v1
/
experiments
p = Parea(api_key="PAREA_API_KEY")  # replace with your API key

exp_uuids = p.list_experiment_uuids(ListExperimentUUIDsFilters())

[
  {
    "name": "<string>",
    "project_uuid": "<string>",
    "uuid": "<string>",
    "created_at": "<string>",
    "status": "pending",
    "pinned_stats": [
      {
        "var1": "<string>",
        "operation": "mean",
        "value": 123,
        "var2": "<string>"
      }
    ],
    "run_name": "<string>",
    "is_public": false,
    "metadata": {},
    "num_samples": 123
  }
]
p = Parea(api_key="PAREA_API_KEY")  # replace with your API key

exp_uuids = p.list_experiment_uuids(ListExperimentUUIDsFilters())

Authorizations

​
x-user-id
string
header
required

Body

application/json
​
project_name
string | null

Name of the project to filter experiments by.

​
metadata_filter
Metadata Filter · object

Filters experiments to contain the given metadata. The metadata_filter is a dictionary where the keys are the metadata keys and the values are the metadata values to filter by.

​
experiment_name_filter
string | null

Filters experiments to contain the given string in their name.

​
run_name_filter
string | null

Filters experiments to contain the given string in their run name.

​
experiment_uuids
string[] | null

Filters experiments to contain the given UUIDs.

Response

Successful Response

​
name
string
required

Name of the experiment

​
project_uuid
string
required

UUID of the project associated with this experiment

​
uuid
string
required

UUID of the created experiment

​
created_at
string
required

Timestamp the experiment was created

​
status
enum<string>
required

Status of the experiment

Available options:
pending,
running,
completed,
failed
​
pinned_stats
ExperimentPinnedStatistic · object[]
required

List of population/dataset-level statistics. Typically contains mean of any reported scores, latencies, etc.

​
run_name
string | null

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

​
is_public
boolean
default:false

If experiment should be public

​
metadata
Metadata · object

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

​
num_samples
integer | null

Number of samples in the experiment