Voiceflow bearer token
Tests
Check agent behavior with repeatable tests.
See Authentication for credentials and permissions.
Returns every test in the environment. A test is a scripted conversation replayed against the agent. The call takes no paging parameters, so one request yields the whole set.
Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns every test defined on the project's environment, each with its launch settings and a turnOrder listing the IDs of its turns in execution order. The turns themselves are fetched separately.
Adds a test to the environment, a scripted conversation replayed against the agent. The response carries the ID that later calls address it by.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Response
Creates the test and returns it with its assigned id. A test holds no conversation of its own, so use that id to create the turns that make it up.
Adds several tests to the environment in one request, each taking the fields the single-create call takes. The response carries the created tests in the same shape the list call returns.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Response
Creates one test per entry in the request body and returns them all with their assigned IDs. Turns are attached afterwards, and a turn batch targets one test at a time.
Returns a single test by ID, with the fields that define it. A test is a scripted conversation replayed against the agent.
Authentication
Voiceflow bearer token
Path parameters
The ID of the test to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Returns one test's name, launch settings, and turnOrder, which is the IDs of its turns in the order they run. Fetch the turns themselves by test ID, and their checks by turn ID.
Changes an existing test in place. The response carries only a confirmation message, so refetch the test to read its new values.
Authentication
Voiceflow bearer token
Path parameters
The ID of the test to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The IDs of the test's turns, in execution order.
Response
Confirms the test's name, launch settings, or turnOrder were updated. The body is a message only, and turnOrder is where a conversation's sequence lives, since turns carry no position of their own.
A human-readable message confirming the update.
Deletes a single test by ID. A test is a scripted conversation replayed against the agent. The response carries only a confirmation message, so refetch the tests to see what is left.
Authentication
Voiceflow bearer token
Path parameters
The ID of the test to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
Confirms the test was deleted. The body is a message only and reports nothing about the test's turns, checks, or past runs, which are separate resources.
A human-readable message confirming the deletion.