Skip to main content

Trigger test suite execution

POST 
/ai/assistants/tests/test-suites/:suite_name/runs

Executes all tests within a specific test suite as a batch operation

Request ​

Path Parameters

    suite_name Suite Namerequired

Responses ​

201: Returns array of created test runs for all tests in the suite

Schema

  • Array [

    • run_id uuidrequired

    Unique identifier for this specific test run execution.

    test_id uuidrequired

    Identifier of the assistant test that was executed.

    status TestStatus (string)required

    Possible values: [pending, starting, running, passed, failed, error]

    Represents the lifecycle of a test:

    • 'pending': Test is waiting to be executed.
    • 'starting': Test execution is initializing.
    • 'running': Test is currently executing.
    • 'passed': Test completed successfully.
    • 'failed': Test executed but did not pass.
    • 'error': An error occurred during test execution.
    triggered_by Triggered By (string)required

    How this test run was initiated (manual, scheduled, or API).

    completed_at date-time

    Timestamp when the test run finished execution.

    logs Logs (string)

    Detailed execution logs and debug information.

    conversation_id Conversation Id (string)

    Identifier of the conversation created during test execution.

    conversation_insights_id Conversation Insights Id (string)

    Identifier for conversation analysis and insights data.

    test_suite_run_id uuid

    Identifier linking this run to a test suite execution batch.

    created_at date-timerequired

    Timestamp when the test run was created and queued.

    updated_at date-time

    Timestamp of the last update to this test run.

    detail_status

    object[]

    Detailed evaluation results for each rubric criteria. Name is name of the criteria from the rubric and status is the result of the evaluation. This list will have a result for every criteria in the rubric section.

  • Array [

    • name Name (string)required
    status TestStatus (string)required

    Possible values: [pending, starting, running, passed, failed, error]

    Represents the lifecycle of a test:

    • 'pending': Test is waiting to be executed.
    • 'starting': Test execution is initializing.
    • 'running': Test is currently executing.
    • 'passed': Test completed successfully.
    • 'failed': Test executed but did not pass.
    • 'error': An error occurred during test execution.

  • ]

    • Detailed evaluation results for each rubric criteria. Name is name of the criteria from the rubric and status is the result of the evaluation. This list will have a result for every criteria in the rubric section.

  • ]

422: Validation Error

Schema

    detail

    object[]

  • Array [

    • loc

    object[]

    required

  • Array [

    • anyOf

    string

  • ]

    • msg Message (string)required
    type Error Type (string)required

  • ]

Request samples

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

Response samples

[
  {
    "run_id": "987fcdeb-51a2-43d1-b456-426614174000",
    "test_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "pending",
    "triggered_by": [
      "manual",
      "cron"
    ],
    "completed_at": "2024-07-29T15:51:28.071Z",
    "logs": "string",
    "conversation_id": "string",
    "conversation_insights_id": "string",
    "test_suite_run_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created_at": [
      "2024-01-15T10:30:00Z"
    ],
    "updated_at": "2024-07-29T15:51:28.071Z",
    "detail_status": [
      {
        "name": "string",
        "status": "pending"
      }
    ]
  }
]