Tests

Get test

Retrieve a specific test by its ID.

GET /tests/{id}

Authorization

HeaderTypeDescription

Authorizationrequired

string

Header with your API key as a Bearer token: Bearer <api-key>. See Authentication.

Path parameters

NameTypeDescription

idrequired

string

The id of the item to retrieve

Response

200Successful Response

PropertyTypeDescription

idrequired

string

createdAt

string (date-time)

updatedAt

string (date-time)

scenario

object

id

string

name

string

namerequired

string

description

string

Default: ""

instruction

string

What the tester does

Default: ""

assertions

object[]

What the conversation is judged on

Default: []

criteriarequired

string

The criteria to evaluate

severityrequired

enum<string>

The severity level of this assertion

Allowed values: blocker, medium, low

fields

object

Values for the test's custom fields

Default: {}

parentTest

string

Set on a variant: the test it varies. A variant's instruction and assertions hold only what differs from its parent.

isEnabled

boolean

Whether runs of the scenario include this test

Default: true

isArchived

boolean

Default: false

Runs

List runs