Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Required string length: 1 - 255
Pattern: ^[A-Za-z0-9_-]{1,255}$

Path Parameters

suite_name
string
required

Name of the suite.

Body

application/json

Request model for triggering test suite runs.

Optional request body for the trigger test suite runs endpoint.

destination_version_id
string

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:

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

Response

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

run_id
string<uuid>
required

Unique identifier for this specific test run execution.

Example:

"987fcdeb-51a2-43d1-b456-426614174000"

test_id
string<uuid>
required

Identifier of the assistant test that was executed.

Example:

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

status
enum<string>
required

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.
Available options:
pending,
starting,
running,
passed,
failed,
error
triggered_by
string
required

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

Example:

"cron"

created_at
string<date-time>
required

Timestamp when the test run was created and queued.

Example:

"2024-01-24T10:30:00Z"

completed_at
string<date-time>

Timestamp when the test run finished execution.

logs
string

Detailed execution logs and debug information.

conversation_id
string

Identifier of the conversation created during test execution.

conversation_insights_id
string

Identifier for conversation analysis and insights data.

test_suite_run_id
string<uuid>

Identifier linking this run to a test suite execution batch.

updated_at
string<date-time>

Timestamp of the last update to this test run.

detail_status
TestRunDetailResult · 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.