Custom Metrics

Delete Custom Metric

Delete a specific custom metric by ID.

delete/v1/custom-metric/{metric_id}

Path parameters

metric_idstring uuid required

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Response

Successful Response

namestring required
promptstring nullable
summarystring nullable
metric_typestring
eval_methodstring
settingsobject
sourcestring
eval_segmentstring
scopestring
response_type'pass_fail' | 'yes_no' | 'qualitative' | 'quantitative' | 'json' | 'enum' | 'int' | 'float' | 'boolean' | 'tool_call' required

Enum representing the possible response types for custom metrics.

min_valuenumber nullable
max_valuenumber nullable
created_atstring date-time nullable
updated_atstring date-time nullable
updated_bystring uuid nullable
created_bystring uuid nullable
idstring uuid nullable

Unique identifier for the metric

categorystring nullable
tagsstring[]
scoring_guidancestring nullable
eval_modality'AUDIO' | 'TEXT' | 'AUTO'

Enum representing the evaluation route of a call.

modelstring nullable
audio_modelstring nullable
temperaturenumber nullable
enum_optionsstring[] nullable
json_schemaobject nullable
organization_idstring uuid nullable
workspace_idstring nullable
allow_not_applicableboolean
template_idstring uuid nullable

Changes

Changed in 4 of the 22 revisions of this API.1716

    • added the new optional header request parameter X-Organization-Id

      new-optional-request-parameter

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

  • 44d183272ce11711See the full diff
    • removed the required property from the response with the status

      response-required-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • removed the optional property from the response with the status

      response-optional-property-removed

    • added the new boolean enum value to the response property for the response status

      response-property-enum-value-added

    • added the new float enum value to the response property for the response status

      response-property-enum-value-added

    • added the new int enum value to the response property for the response status

      response-property-enum-value-added

    • endpoint deprecated

      endpoint-deprecated

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog