CEcekura
test_framework

Generate metrics

Changed on

Suggest metrics for an agent and return them. The metrics are not saved; pass them to Create Metrics in Bulk to keep them. The agent needs a description of at least 100 characters. Usually takes under a minute.

post/test_framework/v3/metrics/generate_metrics/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v3/metrics/generate_metrics/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer
    • or HTTP bearer

Request body

agent_idinteger

The ID of the AI agent to generate metrics for. Either agent_id or assistant_id must be provided.

assistant_idstring

The assistant ID to generate metrics for. Either agent_id or assistant_id must be provided.

num_metricsinteger

Number of metrics to generate

Response

status'completed' | 'failed'

failed when the job could not produce its result; see error / errors.

agent_idinteger
current_stepstring
metricsobject[]

Suggested metrics. They are not saved; pass them to Create Metrics in Bulk.

errorstring nullable

Why the job failed, when it did.

Changes