List assistant tests with pagination

GET 
/ai/assistants/tests

Retrieves a paginated list of assistant tests with optional filtering capabilities

Query Parameters

page[size] Page[Size]

Possible values: >= 1 and <= 100

Default value: 20

Number of tests to return per page (1-100)

page[number] Page[Number]

Possible values: >= 1

Default value: 1

Page number to retrieve (1-based indexing)

test_suite Test Suite

Filter tests by test suite name

telnyx_conversation_channel Telnyx Conversation Channel

Filter tests by communication channel (e.g., 'web_chat', 'sms')

destination Destination

Filter tests by destination (phone number, webhook URL, etc.)

200: Returns paginated test list with metadata for navigation and filtering

application/json

• Schema
• Example (from schema)

Schema

meta

object

required

total_pages integerrequired

total_results integerrequired

page_number integerrequired

page_size integerrequired

data

object[]

required

Array of assistant test objects for the current page.

Array [

test_id uuidrequired

Unique identifier for the assistant test.

name Name (string)required

Human-readable name of the test.

description Description (string)

Detailed description of the test's purpose and scope.

telnyx_conversation_channel TelnyxConversationChannel (string)required

Possible values: [phone_call, web_call, sms_chat, web_chat]

destination Destination (string)

Target destination for test conversations.

max_duration_seconds Max Duration Seconds (integer)

Maximum allowed duration for test execution in seconds.

test_suite Test Suite (string)

Test suite grouping for organizational purposes.

instructions Instructions (string)

Detailed test scenario instructions and objectives.

rubric

object[]

required

Evaluation criteria used to assess test performance.

Array [

name stringrequired

Label for the evaluation criterion, e.g., Empathy, Accuracy, Clarity.

criteria stringrequired

Specific guidance on how to assess the assistant’s performance for this rubric item.

]

Evaluation criteria used to assess test performance.

created_at date-timerequired

Timestamp when the test was created.

]

Array of assistant test objects for the current page.

{
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  },
  "data": [
    {
      "test_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Customer Support Bot Test",
      "description": "string",
      "telnyx_conversation_channel": "phone_call",
      "destination": "string",
      "max_duration_seconds": 0,
      "test_suite": "string",
      "instructions": "string",
      "rubric": [
        [
          {
            "criteria": "Responds within 30 seconds",
            "name": "Response Time"
          }
        ]
      ],
      "created_at": [
        "2024-01-15T09:00:00Z"
      ]
    }
  ]
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/assistants/tests' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  },
  "data": [
    {
      "test_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Customer Support Bot Test",
      "description": "string",
      "telnyx_conversation_channel": "phone_call",
      "destination": "string",
      "max_duration_seconds": 0,
      "test_suite": "string",
      "instructions": "string",
      "rubric": [
        [
          {
            "criteria": "Responds within 30 seconds",
            "name": "Response Time"
          }
        ]
      ],
      "created_at": [
        "2024-01-15T09:00:00Z"
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}