AI Tests

Retrieve an evaluator scenario

Changed on

Returns the specified evaluator scenario with full detail.

get/ai/tests/test_framework/v1/scenarios/{id}

Request

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

Path parameters

idinteger required

Numeric ID of the evaluator scenario.

Response

Evaluator scenario detail.

idinteger required
namestring required
agentinteger nullable required
projectinteger nullable
personalityinteger nullable
personality_namestring
tagsstring[]
tool_idsstring[]
runsinteger[]
metricsinteger[]
metric_namesstring[]
phone_numberstring
first_messagestring
inbound_phone_numberinteger nullable
instructionsstring
simulation_descriptionstring
information_fieldsobject nullable
expected_outcome_promptstring
scenario_languagestring nullable
scenario_typestring
suite_typestring
is_predefinedboolean
test_profileinteger nullable
dynamic_variable_valuesobject nullable
folder_pathstring nullable
max_durationinteger nullable

Example response

{
  "id": 9512,
  "name": "Refund escalation flow",
  "agent": 1259,
  "project": null,
  "personality": 4643,
  "personality_name": "Interruptive (High)",
  "tags": [
    "support",
    "regression"
  ],
  "tool_ids": [],
  "runs": [],
  "metrics": [
    266881,
    266882
  ],
  "metric_names": [
    "AI interrupting user",
    "Average Pitch (in Hz)"
  ],
  "phone_number": "+13125550188",
  "outbound_phone_number_data": null,
  "first_message": "Hi, I want a refund.",
  "inbound_phone_number": null,
  "inbound_phone_number_data": null,
  "instructions": "Call the support line and demand a refund for a damaged product.",
  "simulation_description": "Simulates an impatient customer demanding a refund.",
  "information_fields": null,
  "expected_outcome_prompt": "The assistant explains the refund policy and offers escalation.",
  "scenario_language": "en",
  "scenario_type": "workflow",
  "suite_type": "predefined",
  "is_predefined": false,
  "test_profile": null,
  "test_profile_data": null,
  "dynamic_variable_values": null,
  "folder_path": null,
  "max_duration": null
}

Changes