AI Tests

Retrieve a test agent

Changed on

Returns the specified test agent.

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

Request

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

Path parameters

idinteger required

Numeric ID of the test agent.

Response

Test agent detail.

idinteger required
agent_namestring required

Name of the test agent.

contact_numberstring

Contact phone number for the test agent.

inboundboolean

Whether the test agent accepts inbound calls.

descriptionstring
languagestring

ISO language code the test agent converses in.

assistant_idstring required

ID of the Telnyx AI assistant under test.

chat_assistant_idstring

ID of the chat assistant under test, when testing text channels.

llm_system_promptstring
llm_modelstring

Model used to drive the test agent's side of the conversation.

llm_temperaturenumber
llm_max_tokensinteger
outbound_auto_callboolean
sip_endpointstring
sip_authobject nullable
enabled_personalitiesinteger[]

IDs of the test personalities enabled for this agent.

auto_update_dropoff_nodesboolean
auto_update_topic_nodesboolean
hallucination_metric_kb_filesinteger[]
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": 1259,
  "agent_name": "Support Bot Under Test",
  "contact_number": "+13125550123",
  "inbound": false,
  "description": "Evaluates the support assistant against generated callers.",
  "language": "en",
  "assistant_id": "e1a2b3c4-d5e6-f7a8-b9c0-d1e2f3a4b5c6",
  "chat_assistant_id": "",
  "llm_system_prompt": "You are calling a customer support line.",
  "llm_model": "openai/gpt-oss-120b",
  "llm_temperature": 0.7,
  "llm_max_tokens": 512,
  "outbound_auto_call": false,
  "sip_endpoint": "",
  "sip_auth": null,
  "knowledge_base_files": [],
  "enabled_personalities": [
    4567
  ],
  "auto_update_dropoff_nodes": false,
  "auto_update_topic_nodes": false,
  "hallucination_metric_kb_files": [],
  "outbound_numbers": [],
  "created_at": "2026-10-13T18:04:05.123456Z",
  "updated_at": "2026-10-13T18:04:05.123456Z"
}

Changes