POST
/
api
/
parea
/
v1
/
experiment
curl --request POST \
  --url https://parea-ai-backend-us-9ac16cdbc7a7b006.onporter.run/api/parea/v1/api/parea/v1/experiment \
  --header 'Content-Type: application/json' \
  --header 'x-user-id: <api-key>' \
  --data '{
  "metadata": {
    "dataset": "dev 123"
  },
  "name": "Test Experiment",
  "project_uuid": "...",
  "run_name": "test-experiment"
}'
{
  "created_at": "2024-05-30 13:48:34",
  "metadata": {
    "dataset": "dev 123"
  },
  "name": "Test Experiment",
  "project_uuid": "...",
  "run_name": "test-experiment",
  "uuid": "..."
}

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

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

Response

200
application/json
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
object | null

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