v1

latestOpenAPI 3.0.12026-07-2696152184.1 KB
Agents

Create Metric

Create a new metric.

post/agents/metrics

Headers

Cartesia-Version'2026-03-01' date required
Example:2026-03-01

API version header.

Request body

namestring required

The name of the metric. This must be a unique name that only allows lower case letters, numbers, and the characters _, -, and .

display_namestring nullable

The display name of the metric.

promptstring required

The prompt associated with the metric, detailing the task and evaluation criteria.

Response

idstring required

The unique identifier for the metric.

namestring required

The name of the metric. This is a unique name that you can use to identify the metric in the CLI.

display_namestring nullable

The display name of the metric, if available. This is the name that is displayed in the Playground.

promptstring required

The prompt associated with the metric, detailing the task and evaluation criteria.

created_atstring date-time required

The timestamp when the metric was created.