Skip to main content
POST
Create a New Test Run

Authorizations

X-Api-Key
string
header
required

API Key for authentication. Click here to access API Key

X-Secret-Key
string
header
required

Secret Key for authentication. Click here to access Secret Key

Body

application/json
name
string
required

A unique name for the test run.

scenarioIds
string<uuid>[]
required

A list of scenario UUIDs to be included in this test run.

agentDefinitionId
string<uuid>
required

The UUID of the agent definition to be tested.

description
string

An optional description for the test run.

agentVersion
string<uuid> | null

The specific UUID of the agent version to be tested. If not provided, the active version will be used.

evalConfigIds
string<uuid>[]

A list of existing evaluation configuration UUIDs to associate with this test run.

evaluationsConfig
object[]

A list of new, detailed evaluation configurations to create and associate with this test run.

datasetRowIds
string<uuid>[]

A list of specific dataset row UUIDs to test against.

enableToolEvaluation
boolean
default:false

Flag to enable tool evaluation for this test run.

Response

The test run was created successfully.

id
string<uuid>
name
string
description
string
status
string
scenarios
object[]
agent_definition
string<uuid>
agent_version
string<uuid>
evaluations
object[]
created_at
string<date-time>
updated_at
string<date-time>