Rest APIAPI ReferenceExperiments

Create experiment

Create experiment

Request

This endpoint expects an object.
dataset_namestring or nullRequired>=1 character
idstringOptionalformat: "uuid"
project_idstringOptionalformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

project_namestringOptionalformat: "(?s)^\s*(\S.*\S|\S)\s*$"

Project name. Creates project if it doesn’t exist. Ignored when project_id is provided.

namestringOptional
metadatamap from strings to any or list of objects or stringOptional
tagslist of stringsOptional
typeenumOptional
Allowed values:
evaluation_methodenumOptional
Allowed values:
optimization_idstringOptionalformat: "uuid"
statusenumOptional
Allowed values:
experiment_scoreslist of objectsOptional
prompt_versionobjectOptional
prompt_versionslist of objectsOptional
dataset_version_idstringOptionalformat: "uuid"
ID of the dataset version this experiment is linked to. If not provided at creation, experiment will be automatically linked to the latest version.

Response headers

Locationstring

Response

Created