Sign in
custom-metrics

Update Custom Metric

Edit a custom metric.

A new revision is created ONLY when a revision-defining field (prompt/model/config/allow_na) actually changes — that correctly hides results produced under the old config. Metric-level metadata (name/description/category/tags/linked agents/applies_to_*) is applied to the metric row in place and never spawns a revision: every historical MetricResult joins on active_revision_id, so a cosmetic edit that repointed it would silently orphan (zero) the metric's entire history across the logs page, widgets, drill and export. Never mutates existing revisions.

put/api/v1/custom-metrics/{metric_id}

Path parameters

metric_idstring uuid required

Request body

namestring nullable
descriptionstring nullable
categorystring nullable
tagsstring[] nullable
linked_agent_idsstring[] nullable
applies_to_voiceboolean nullable
applies_to_textboolean nullable
applies_to_emailboolean nullable
applies_to_bookingboolean nullable
promptstring nullable
modelstring nullable
configobject nullable
allow_naboolean nullable
proofstring nullable

Response

Successful Response

Changes

No recorded changes to this endpoint across all 4 revisions of this API.