POST
/
api
/
parea
/
v1
/
experiments

Authorizations

x-user-id
string
headerrequired

Body

application/json
project_name
string | null

Name of the project to filter experiments by.

metadata_filter
object | null

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

200 - application/json
name
string
required

Name of the experiment

run_name
string | null

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

project_uuid
string
required

UUID of the project associated with this experiment

is_public
boolean
default: false

If experiment should be public

metadata
object | null

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

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
object[]
required

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

num_samples
integer | null

Number of samples in the experiment