AI Tests

Generate test metrics

Changed on

Starts background generation of suggested metrics for a test agent. Returns a progress ID to poll with the get-test-metric-generation-progress endpoint.

post/ai/tests/test_framework/v1/metrics/generate_metrics

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/ai/tests/test_framework/v1/metrics/generate_metrics
  • Auth: HTTP bearer

Request body

agent_idinteger required

Test agent to suggest metrics for.

num_metricsinteger required

How many metrics to suggest.

scenariosinteger[]

Scenario IDs to base the suggestions on.

Example request

{
  "agent_id": 1259,
  "num_metrics": 5,
  "scenarios": [
    9512
  ]
}

Response

Metric generation initiated.

progress_idstring required

Identifier to poll generation progress with.

Example response

{
  "progress_id": "b7e4c1a2-3d4f-5a6b-8c9d-0e1f2a3b4c5d"
}

Changes