Run Tests On The Agent

Changed on

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

Request

Path parameters

agent_idstring required

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

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

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.

Request body

namestring nullable

Optional name for the test invocation.

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
namestring nullable

The user-provided name of the test invocation, if one was set.

agent_idstring nullable
branch_idstring nullable
version_idstring nullable
ran_against_draftboolean
created_atinteger
folder_idstring nullable
repeat_countinteger
cancelledboolean
bucketing_status'pending' | 'completed' | 'failed'

Changes

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property //////////

    • info

      added the new optional request property ///////

    • info

      added the new optional request property //////////////////

    • info

      added the new optional request property //////////////////

    • info

      added the new optional request property //////////////////

    • info

      added the new optional request property //////////////////

    • info

      added the new optional request property //////////////////

    • info

      added the new optional request property //////////////////

    • info

      added the new optional request property //////////////////

    • info

      added the new optional request property //////////////////

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property //////////////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property //////////////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////////////// to the response with the status

    • info

      added the required property //////////// to the response with the status

    • info

      added the required property //////////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////////////// to the response with the status

    • info

      added the required property //////////// to the response with the status

    • info

      added the required property //////////////////// to the response with the status

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property ////////////////// to the response with the status

    • info

      added the required property //////////// to the response with the status

    • info

      added the required property //////////////////// to the response with the status