experiment_templates

List Experiment Templates

List a project's experiment templates.

project_id is required. Protocols are project-scoped: every project holds its own copies of the built-in catalog, so an organization-wide list returns the same protocol once per project rather than a meaningful catalog. This endpoint used to union the org's unscoped rows with the system organization's; both of those sources are gone in the contract phase, so rather than silently returning N copies of everything it now rejects the call. The response is lightweight by default: large JSONB columns (protocol_config, parameters_schema, time_series_spec, metrics_spec, plot_options) and the source_protocol text are omitted unless explicitly requested via ?include=. Fetch the full template via GET /{template_id} when the user opens one.

Parameters

limit : int | None, optional Page size (1-100). When omitted, one page of up to PostgREST's max_rows is returned; compare count against total to detect that there is more. offset : int | None, optional Number of records to skip before the page starts. include : str | None, optional Comma-separated list of heavy columns to include in the response. Supported values: protocol_config, parameters_schema, time_series_spec, metrics_spec, plot_options, source_protocol. Unknown names are silently ignored. project_id : str Project whose protocols to return. Required — see above. name : str | None, optional Text filter on the protocol name, per the field's policy in _PROTOCOL_FILTERS: ilike.%rpt% for a partial match, eq.RPT for an exact one. A bare value is equality. created_by_email : str | None, optional Text filter on the creator's email, same operator syntax as name. created_at, updated_at : str | None, optional Date filters: gte.value / lte.value etc. Use the _gt / _lt variants together for a between query. order_by : str, optional Column to sort by. Defaults to created_at. order : str, optional Sort direction. Defaults to desc.

Returns

ExperimentTemplateListResponse items, count (rows in this response) and total (every protocol matching the filters). count < total means the result was truncated — page through with limit / offset to get the rest.

Raises

BadRequestError If project_id is omitted, or a filter value violates its field policy. An unsupported order_by / order is a 422 from FastAPI.

get/experiment_templates

Query parameters

limitinteger nullable
offsetinteger nullable
includestring nullable
qstring nullable

Free-text search on template name plus prefix full-text match, matching the global search.

Free-text search on template name plus prefix full-text match, matching the global search.

project_idstring nullable
namestring nullable
descriptionstring nullable
created_by_emailstring nullable
protocol_group_idstring nullable
created_atstring nullable
created_at_gtstring nullable
created_at_ltstring nullable
updated_atstring nullable
updated_at_gtstring nullable
updated_at_ltstring nullable
order_by'name' | 'created_at' | 'updated_at'
order'asc' | 'desc'

Response

Successful Response

countinteger required
totalinteger required

Changes