AI Tests

List test agents

Changed on

Returns a paginated list of test agents in your organization. A test agent wraps the Telnyx AI assistant under test and drives simulated callers against it.

get/ai/tests/test_framework/v1/aiagents

Request

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

Query parameters

pageinteger

Page number (1-based).

page_sizeinteger

Number of results per page.

Response

Paginated list of test agents.

countinteger required
nextstring uri nullable required

Link to the next page of results, or null.

previousstring uri nullable required

Link to the previous page of results, or null.

Example response

{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "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