AI Tests

List evaluator scenarios

Changed on

Returns a paginated list of evaluator scenarios in your organization, optionally filtered by test agent or tags.

get/ai/tests/test_framework/v1/scenarios

Request

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

Query parameters

pageinteger

Page number (1-based).

page_sizeinteger

Number of results per page.

agent_idinteger

Filter scenarios belonging to the specified test agent.

assistant_idstring

Filter scenarios belonging to the specified Telnyx assistant.

tagsstring

Filter scenarios by a comma-separated list of tags.

Response

Paginated list of evaluator scenarios.

countinteger required
nextstring uri nullable required
previousstring uri nullable required

Example response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 9512,
      "name": "Refund escalation flow",
      "personality": 4643,
      "personality_name": "Interruptive (High)",
      "phone_number": "+13125550188",
      "expected_outcome_prompt": "The assistant explains the refund policy and offers escalation.",
      "instructions": "Call the support line and demand a refund for a damaged product.",
      "scenario_language": "en",
      "scenario_type": "workflow",
      "tags": [
        "support",
        "regression"
      ],
      "agent": 1259,
      "inbound_phone_number": null,
      "inbound_phone_number_data": null,
      "metrics": [
        266881,
        266882
      ],
      "metric_names": [
        "Greeting quality",
        "Escalation quality"
      ],
      "first_message": "Hi, I want a refund.",
      "tool_ids": [],
      "test_profile": null,
      "test_profile_data": null,
      "dynamic_variable_values": null,
      "created_at": "2026-10-13T18:04:05.123456Z",
      "updated_at": "2026-10-13T18:04:05.123456Z",
      "last_updated_by": 1,
      "folder_path": null
    }
  ]
}

Changes