Get test

Gets 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

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.

check_any_tool_matchesboolean or null
If set to True this test will pass if any tool call returned by the LLM matches the criteria. Otherwise it will fail if more than one tool is returned by the agent.
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
typeenum or null
Allowed values:
from_conversation_metadataobject or null

Metadata of a conversation this test was created from (if applicable).

Errors