Retrieve a test agent

GET

tests

test_framework

aiagents

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const TestAgent = await client.ai.tests.testFramework.v1.aiagents.retrieve('id');

console.log(TestAgent.id);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
test_agent = client.ai.tests.test_framework.v1.aiagents.retrieve(
    "id",
)
print(test_agent.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	aiagent, err := client.AI.Tests.TestFramework.V1.Aiagents.Get(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", aiagent.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var response = client.ai().tests().testFramework().v1().aiagents().retrieve("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $test_agent = $client->ai->tests->testFramework->v1->aiagents->retrieve(
    'id',
  );

  var_dump($test_agent);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "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"
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

integer

required

Numeric ID of the test agent.

Response

Test agent detail.

integer

required

agent_name

string

required

Name of the test agent.

assistant_id

string

required

ID of the Telnyx AI assistant under test.

created_at

string<date-time>

required

updated_at

string<date-time>

required

contact_number

string

Contact phone number for the test agent.

inbound

boolean

Whether the test agent accepts inbound calls.

description

string

language

string

ISO language code the test agent converses in.

chat_assistant_id

string

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

llm_system_prompt

string

llm_model

string

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

llm_temperature

number

llm_max_tokens

integer

outbound_auto_call

boolean

sip_endpoint

string

sip_auth

object | null

Show child attributes

knowledge_base_files

any[]

Knowledge-base files associated with the test agent.

enabled_personalities

integer[]

IDs of the test personalities enabled for this agent.

auto_update_dropoff_nodes

boolean

auto_update_topic_nodes

boolean

hallucination_metric_kb_files

integer[]

outbound_numbers

any[] | null

Outbound numbers associated with the test agent.

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const TestAgent = await client.ai.tests.testFramework.v1.aiagents.retrieve('id');

console.log(TestAgent.id);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
test_agent = client.ai.tests.test_framework.v1.aiagents.retrieve(
    "id",
)
print(test_agent.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	aiagent, err := client.AI.Tests.TestFramework.V1.Aiagents.Get(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", aiagent.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var response = client.ai().tests().testFramework().v1().aiagents().retrieve("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $test_agent = $client->ai->tests->testFramework->v1->aiagents->retrieve(
    'id',
  );

  var_dump($test_agent);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "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"
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The AI Tests service rejected the request."
    }
  ]
}

{
  "errors": [
    {
      "code": "10003",
      "title": "Unauthorized",
      "detail": "The API key is missing or invalid."
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Not Found",
      "detail": "The requested resource or URL could not be found."
    }
  ]
}

{
  "errors": [
    {
      "code": "10018",
      "title": "Unprocessable Entity",
      "detail": "Validation failed for the request payload."
    }
  ]
}

{
  "errors": [
    {
      "code": "10029",
      "title": "Too Many Requests",
      "detail": "Too many requests; retry later."
    }
  ]
}

{
  "errors": [
    {
      "code": "10063",
      "title": "Service Unavailable",
      "detail": "The test framework service is temporarily unavailable."
    }
  ]
}

Guides

Missions

AI Insights

Assistants API

Missions API

AI Tests API

Conversations API

For AI Agents

Retrieve a test agent

Authorizations

Path Parameters

Response