POST
/
api
/
parea
/
v1
/
experiment

Authorizations

x-user-id
string
headerrequired

Body

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.

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