v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Assistants

Trigger test suite execution

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

post/ai/assistants/tests/test-suites/{suite_name}/runs

Path parameters

suite_namestring required

Name of the suite.

Request body

destination_version_idstring

Optional assistant version ID to use for all test runs in this suite. If provided, the version must exist or a 400 error will be returned. If not provided, test will run on main version

Example request

{
  "destination_version_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response

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

completed_atstring date-time

Timestamp when the test run finished execution.

conversation_idstring

Identifier of the conversation created during test execution.

conversation_insights_idstring

Identifier for conversation analysis and insights data.

created_atstring date-time required

Timestamp when the test run was created and queued.

logsstring

Detailed execution logs and debug information.

run_idstring uuid required

Unique identifier for this specific test run execution.

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.

test_idstring uuid required

Identifier of the assistant test that was executed.

test_suite_run_idstring uuid

Identifier linking this run to a test suite execution batch.

triggered_bystring required

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

updated_atstring date-time

Timestamp of the last update to this test run.

Example response

[
  {
    "created_at": "2024-01-24T10:30:00Z",
    "run_id": "987fcdeb-51a2-43d1-b456-426614174000",
    "test_id": "123e4567-e89b-12d3-a456-426614174000",
    "triggered_by": "cron"
  }
]