AI Tests

List test personalities

Changed on

Returns the catalogue of test personalities available to your organization. A personality describes how a simulated caller speaks: prompt, language, accent, voice, interruption level, and call-behaviour settings.

get/ai/tests/test_framework/v1/personalities

Request

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

Response

List of test personalities.

idinteger required
forked_frominteger nullable

ID of the personality this one was forked from.

organizationinteger nullable
projectinteger nullable
namestring required

Display name of the personality.

promptstring required

Instructions the simulated caller follows.

languagestring required

ISO language code the simulated caller speaks.

accentstring
background_noisestring nullable
interruption_levelstring nullable

How aggressively the personality interrupts the assistant.

generation_configobject nullable
network_simulationobject nullable
message_planobject nullable

Idle-timeout plan for messages during a call.

stop_speaking_planobject nullable
background_sound_volumenumber nullable
voice_volumenumber nullable
effective_voice_volumenumber nullable
end_call_enabledboolean required

Example response

[
  {
    "id": 4643,
    "name": "Interruptive (High)",
    "prompt": "Speak very impatiently. Comment on trivial things and rarely let others finish speaking.",
    "language": "uk",
    "accent": "Ukrainian",
    "interruption_level": "high",
    "end_call_enabled": true
  }
]

Changes