Skip to main content
POST
/
api
/
parea
/
v1
/
experiment
Create Experiment Api
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 '
{
  "name": "<string>",
  "project_uuid": "<string>",
  "run_name": "<string>",
  "is_public": false,
  "metadata": {}
}
'
{
  "name": "<string>",
  "project_uuid": "<string>",
  "uuid": "<string>",
  "created_at": "<string>",
  "run_name": "<string>",
  "is_public": false,
  "metadata": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.parea.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

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

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