API REFERENCETests

Update test

Updates an agent response test by ID.

Path parameters

test_idstringRequired
The id of a chat response test. This is returned on test creation.

Headers

xi-api-keystringRequired

Request

This endpoint expects an object.
chat_historylist of objectsRequired
success_conditionstringRequired
A prompt that evaluates whether the agent's response is successful. Should return True or False.
success_exampleslist of objectsRequired

Non-empty list of example responses that should be considered successful

failure_exampleslist of objectsRequired

Non-empty list of example responses that should be considered failures

namestringRequired
tool_call_parametersobject or nullOptional

How to evaluate the agent’s tool call (if any). If empty, the tool call is not evaluated.

dynamic_variablesmap from strings to nullable strings or doubles or integers or booleansOptional
Dynamic variables to replace in the agent config during testing

Response

Successful Response
chat_historylist of objects
success_conditionstring
A prompt that evaluates whether the agent's response is successful. Should return True or False.
success_exampleslist of objects

Non-empty list of example responses that should be considered successful

failure_exampleslist of objects

Non-empty list of example responses that should be considered failures

idstring
namestring
tool_call_parametersobject or null

How to evaluate the agent’s tool call (if any). If empty, the tool call is not evaluated.

dynamic_variablesmap from strings to nullable strings or doubles or integers or booleans or null
Dynamic variables to replace in the agent config during testing

Errors