API ReferenceTests

Update Agent Test

Update a test. Only fields present on the request body are changed.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Request

This endpoint expects an object.
namestringOptional<=200 characters
descriptionstringOptional<=2000 characters
configobjectOptional
Replaces the test config when present.
tool_mock_configobjectOptional

Replaces the tool-mock config when present.

folder_idstringOptional

Prefixed wire identifier (folder_<26 char Crockford base32>) of the folder to move the test into.

clear_folder_idbooleanOptional

When true, moves the test back to root (clears folder_id). Wins over folder_id when both are sent.

Response

The updated test.
idstring

Prefixed wire identifier (test_<26 char Crockford base32>). URL paths accept only this prefixed form; legacy UUID path parameters are rejected with 404.

agent_idstring

Prefixed wire identifier (agent_<26 char Crockford base32>) of the owning agent.

namestring<=200 characters
descriptionstring<=2000 characters
typeenum

Discriminates the shape of AgentTest.config.

  • reply - send one message to the agent and judge the response with an LLM.
  • tool - assert that the agent calls a specific tool given a context.
  • simulation - run a multi-turn conversation between the agent and an AI caller.
configobject

Type-specific configuration document.

created_atdatetime
updated_atdatetime
tool_mock_configobject

Optional tool-mocking config applied during runs of this test.

variablesmap from strings to any

Per-test dynamic-variable overrides. Keys substitute {{key}} placeholders inside the test config at run-start. Unknown keys render as empty string, matching session dispatch behaviour.

folder_idstring or null

When set, prefixed wire identifier (folder_<26 char Crockford base32>) of the containing folder. Null means root (unfiled).

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error