Voiceflow bearer token
Test Runs
Run tests and review the results.
See Authentication for credentials and permissions.
Finds past runs of a test, each carrying how many of its checks passed. The body takes take and skip, so results arrive a page at a time rather than all at once.
Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The maximum number of results to return, used for pagination.
The number of results to skip, used for pagination.
Restrict results to runs of this test. Omit to search across all tests.
Response
Returns the runs matching the search body, each carrying the testID it belongs to, its status, its check tallies, and the credits it consumed. Set testID in the body to narrow to one test's history, or omit it to search every test in the environment.
Adds a test run to the environment, one execution of a test, carrying how many of its checks passed. 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
The ID of the test to run.
Response
Creates a run of the test named in the body and returns it, possibly still queued: startedAt is null until execution begins and passedChecks is null until the run finishes. Read the run back by id to follow it through to passed, failed, or canceled.
Adds several test runs to the environment in one request, each taking the fields the single-create call takes. The response carries the created test runs 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
The IDs of the tests to run, one run created per test.
Response
Creates one run for each test ID in the request body and returns them all under a shared bulkID identifying the batch. Each run comes back in the same shape as a single run, with its own status, check tallies, and logs.
Groups the runs created by this call so they can be searched or tracked together.
Stops test runs that have not finished, including queued runs, which are then no longer scheduled. The response names the runs it stopped, the ones that had already finished, and any IDs it could not find.
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
The IDs of the runs to cancel.
Response
Returns canceledRunIDs for the runs this call stopped, finishedRuns with the status of runs that had already finished, and notFoundRunIDs for IDs with no run in this environment.
The runs this call canceled. A run that had not started yet will never start.
Runs that had already finished, so the call left them as they were.
IDs with no run in this environment.
Wait until runs finish or the time is up.
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
The runs to wait for: the IDs create_run or create_many_runs returned (each run's id, not its testID).
How long to wait at most, in seconds: 45 by default, 120 at most.
Response
Every run found has passed, failed or been canceled.
finished, timeout, abortReturns a single test run by ID, with the fields that define it. A test run is one execution of a test, carrying how many of its checks passed.
Authentication
Voiceflow bearer token
Path parameters
The ID of the test run 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 run's outcome: its status, how many checks it evaluated and how many passed, the credits it consumed, and the trace and tool-call events recorded as the agent worked through the conversation. passedChecks and finishedAt are null until the run finishes, and failReason is null unless it finished in a failed state.
Searches the log of one test run, filtering entries by kind, level, debug kind, turn or text, a page at a time. Each page also reports the log's total entry count and token use per model; send nextOffset back for the next page.
Authentication
Voiceflow bearer token
Path parameters
The ID of the test run 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
Keep only entries of these kinds. Omit to keep every kind.
Keep only entries at these levels, for example ["fatal", "error", "warn"] for what went wrong.
Keep only debug entries of these kinds. Setting it leaves out every entry that is not a debug log.
Keep only entries of these turns. Turn 0 holds anything logged before the first input.
Keep only entries whose message or recorded data contains this text, ignoring case. It is plain text, not a regular expression. Separate alternatives with |, as in "timeout|denied", to keep entries that contain any of them.
The most entries to return in one page.
How many matching entries to skip, for paging.
Response
Returns one page of the log entries that match the filters, with the counts for the whole log, the token use per model, and nextOffset for the next page (null on the last page).
Entries in the whole log.
The last turn the log reaches.
How many entries of each kind, level and debug kind the whole log holds, before any filter.
Token use per model over the whole log, largest first.
Entries that pass every filter.
The offset of the next page, or null when this page reaches the last match.
True when the page stopped before limit to stay under about 30,000 tokens. Continue from nextOffset.