Skip to main content
POST
Create Experiment Api

Authorizations

x-user-id
string
header
required

Body

application/json
name
string
required

Name of the experiment

project_uuid
string
required

UUID of the project associated with this experiment

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 | null

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

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

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 | null

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