Get assistant test by ID

Retrieves detailed information about a specific assistant test

GET /ai/assistants/tests/{test_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const assistantTest = await client.ai.assistants.tests.retrieve('test_id');

console.log(assistantTest.test_id);

200

{
  "test_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Customer Support Bot Test",
  "telnyx_conversation_channel": "web_chat",
  "rubric": [
    {
      "criteria": "Responds within 30 seconds",
      "name": "Response Time"
    }
  ],
  "created_at": "2024-01-16T09:00:00Z",
  "description": "<string>",
  "destination": "<string>",
  "max_duration_seconds": 123,
  "test_suite": "<string>",
  "instructions": "<string>"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

test_id · string · required

Unique identifier of the test.

Response

200

application/json

Returns complete test configuration including rubric, schedule, and metadata

Response model containing complete assistant test information.

Returns all test configuration details including evaluation criteria, scheduling, and metadata. Used when retrieving individual tests or after creating/updating tests.

test_id · string<uuid> · required

Unique identifier for the assistant test.

Example:

"123e4567-e89b-12d3-a456-426614174000"

name · string · required

Human-readable name of the test.

Example:

"Customer Support Bot Test"

telnyx_conversation_channel · enum<string> · required

Communication channel used for test execution.

Available options: phone_call, web_call, sms_chat, web_chat

Example:

"web_chat"

rubric · Rubric · object[] · required

Evaluation criteria used to assess test performance.

Show child attributes

Example:

[
  {
    "criteria": "Responds within 30 seconds",
    "name": "Response Time"
  }
]

created_at · string<date-time> · required

Timestamp when the test was created.

Example:

"2024-01-16T09:00:00Z"

description · string

Detailed description of the test's purpose and scope.

destination · string

Target destination for test conversations.

max_duration_seconds · integer

Maximum allowed duration for test execution in seconds.

test_suite · string

Test suite grouping for organizational purposes.

instructions · string

Detailed test scenario instructions and objectives.