Endpoint
POST
/v1/stable/test-run/search

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

take
number
default:20

The maximum number of results to return, used for pagination.

Minimum: 1 · Maximum: 100
skip
integer
default:0

The number of results to skip, used for pagination.

Minimum: 0 · Maximum: 9007199254740991
testID
string

Restrict results to runs of this test. Omit to search across all tests.

Response

200 - application/json

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.

runs
object[]
required
StableTestRun — see its attributes above
Endpoint
POST
/v1/stable/test-run

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

testID
string
required

The ID of the test to run.

Response

201 - application/json

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.

run
object
required
StableTestRun — see its attributes above
Endpoint
POST
/v1/stable/test-run/batch

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

testIDs
string[]
required

The IDs of the tests to run, one run created per test.

Minimum items: 1 · Maximum items: 20

Response

201 - application/json

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.

runs
object[]
required
StableTestRun — see its attributes above
bulkID
string
required

Groups the runs created by this call so they can be searched or tracked together.

Endpoint
POST
/v1/stable/test-run/cancel

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

runIDs
string[]
required

The IDs of the runs to cancel.

Minimum items: 1 · Maximum items: 50

Response

200 - application/json

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.

canceledRunIDs
string[]
required

The runs this call canceled. A run that had not started yet will never start.

finishedRuns
object[]
required

Runs that had already finished, so the call left them as they were.

StableTestRunCancelFinishedRun — see its attributes above
notFoundRunIDs
string[]
required

IDs with no run in this environment.

Endpoint
POST
/v1/stable/test-run/wait

Wait until runs finish or the time is up.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

runIDs
string[]
required

The runs to wait for: the IDs create_run or create_many_runs returned (each run's id, not its testID).

Minimum items: 1 · Maximum items: 50
timeoutSeconds
integer
default:45

How long to wait at most, in seconds: 45 by default, 120 at most.

Minimum: 5 · Maximum: 120

Response

200 - application/json
done
boolean
required

Every run found has passed, failed or been canceled.

stoppedBy
enum<string>
required
Available options: finished, timeout, abort
waitedSeconds
integer
required
Minimum: -9007199254740991 · Maximum: 9007199254740991
runs
object[]
required
notFoundRunIDs
string[]
note
string
Endpoint
GET
/v1/stable/test-run/{runID}

Returns 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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

runID
string
required

The ID of the test run to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Response

200 - application/json

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.

run
object
required
StableTestRun — see its attributes above
Endpoint
POST
/v1/stable/test-run/{runID}/logs

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

runID
string
required

The ID of the test run to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

kinds
object[]

Keep only entries of these kinds. Omit to keep every kind.

Minimum items: 1 · Maximum items: 5
StableLogEntryKind — see its attributes above
levels
object[]

Keep only entries at these levels, for example ["fatal", "error", "warn"] for what went wrong.

Minimum items: 1 · Maximum items: 5
StableLogLevel — see its attributes above
debugKinds
object[]

Keep only debug entries of these kinds. Setting it leaves out every entry that is not a debug log.

Minimum items: 1 · Maximum items: 8
StableLogDebugKind — see its attributes above
turns
integer[]

Keep only entries of these turns. Turn 0 holds anything logged before the first input.

Minimum items: 1 · Maximum items: 100
search
string

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.

Minimum length: 1 · Maximum length: 256
detail
object
default:"summary"
limit
integer
default:50

The most entries to return in one page.

Minimum: 1 · Maximum: 200
offset
integer
default:0

How many matching entries to skip, for paging.

Minimum: 0 · Maximum: 9007199254740991
order
object
default:"asc"

Response

200 - application/json

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).

total
integer
required

Entries in the whole log.

Minimum: -9007199254740991 · Maximum: 9007199254740991
turnCount
integer
required

The last turn the log reaches.

Minimum: -9007199254740991 · Maximum: 9007199254740991
counts
object
required

How many entries of each kind, level and debug kind the whole log holds, before any filter.

StableLogCounts — see its attributes above
tokens
object[]
required

Token use per model over the whole log, largest first.

StableLogTokenUsage — see its attributes above
matches
integer
required

Entries that pass every filter.

Minimum: -9007199254740991 · Maximum: 9007199254740991
entries
object[]
required

This page of the matching entries.

StableLogEntry — see its attributes above
hasMore
boolean
required
nextOffset
integer
required

The offset of the next page, or null when this page reaches the last match.

Minimum: -9007199254740991 · Maximum: 9007199254740991
truncated
boolean
required

True when the page stopped before limit to stay under about 30,000 tokens. Continue from nextOffset.

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.