Trigger test metric execution
Trigger execution of a metric against one or more simulation outputs for testing purposes. This is an asynchronous operation that returns immediately.
Provide exactly one of simulation_output_id (single, deprecated) or
simulation_output_ids (batch, up to 100 IDs per call). Batch requests
are best-effort: individual simulation outputs that cannot be queued are
reported in results with a non-QUEUED status instead of failing the
whole call.
The response contains one entry per requested simulation output in
results, each with its own status and, when queued, a
metric_output_ulid.
Retrieving results: for each queued entry, poll
GET /v1/simulations/{simulation_id}/metrics/{metric_output_id} using the
entry’s simulation_output_id as simulation_id and its 26-char
metric_output_ulid as metric_output_id. The response includes a
status field (IN QUEUE, IN PROGRESS, COMPLETED, FAILED) — poll
until it is terminal. Test results belong to the simulation they ran
against, so they are not available on the conversations endpoint.
Authorizations
API key for authentication
Path Parameters
The metric ID (22-character ShortUUID)
^[a-zA-Z0-9]{22}$Body
Provide exactly one of simulation_output_id or simulation_output_ids.
Deprecated: a single simulation output ID (22-character ShortUUID) to run the metric against. Prefer simulation_output_ids.
^[a-zA-Z0-9]{22}$Simulation output IDs (22-character ShortUUIDs) to run the metric against; 1–100 per call.
1 - 100 elements^[a-zA-Z0-9]{22}$Optional developer identifier for debugging
Response
All requested test metric executions queued successfully
One entry per requested simulation output.
Deprecated: the ULID of the created metric output, used to track the result. Only set for single simulation_output_id requests; null for batch (simulation_output_ids) requests, which should read results instead.
26^[0-9A-HJKMNP-TV-Z]{26}$