Sign in
experiment_templates

Create Experiment Template

Create a new experiment template.

Parameters

body : CreateExperimentTemplateBody Template creation data.

Returns

ExperimentTemplate Created experiment template.

post/experiment_templates

Request body

namestring required
descriptionstring nullable
protocol_configobject required
parameters_schemaobject
time_series_specobject
metrics_specobject
source_protocolstring nullable
force_createboolean
project_idstring nullable
protocol_group_idstring nullable

Response

Successful Response

idstring nullable

Unique identifier for the template

namestring required

Name of the template

descriptionstring nullable

Description of the template

description_templatestring nullable

Template string for generating user-facing descriptions with {{param}} placeholders

protocol_configobject nullable

Protocol configuration (UCP format). Omitted from list responses by default; opt in via ?include=protocol_config.

parameters_schemaobject nullable

Parameters schema defining what parameters this template accepts. Omitted from list responses by default; opt in via ?include=parameters_schema.

organization_idstring required

ID of the organization that owns this template

created_atstring nullable

When the template was created

updated_atstring nullable

When the template was last updated

plot_optionsobject

Plot configuration options organized by plot type (time_series, metrics)

time_series_specobject

Specification mapping time-series keys to calculation rules.

metrics_specobject

Specification mapping metric names to calculation rules.

source_protocolstring nullable

Original protocol text as entered by the user

created_bystring nullable

User ID of the user who created this template

created_by_emailstring nullable

Email of the user who created this template

project_idstring nullable

ID of the project that owns this protocol. Every protocol reachable through the API is project-scoped; None only on unmigrated rows.

protocol_group_idstring nullable

ID of the protocol group this protocol belongs to. Protocols sharing a group are related. None means ungrouped. The group is always in the same project as the protocol.

Changes