Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

Run Tests On The Agent

Run selected tests on the agent with provided configuration. If the agent configuration is provided, it will be used to override default agent configuration.

post/v1/convai/agents/{agent_id}/run-tests

Path parameters

agent_idstring required

The id of an agent. This is returned on agent creation.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

The id of an agent. This is returned on agent creation.

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

branch_idstring nullable

ID of the branch to run the tests on. If not provided, the tests will be run on the agent's main branch.

repeat_countinteger

Number of times to run each test. When greater than 1, results are grouped and summarized.

Response

Successful Response

idstring required
agent_idstring nullable
branch_idstring nullable
created_atinteger
folder_idstring nullable
repeat_countinteger
bucketing_status'pending' | 'completed' | 'failed'