Endpoint
GET
/v1/stable/test-check

Returns every test check in its turn. A test check is one assertion about an agent turn, comparing the reply or the behaviour behind it. The call takes no paging parameters, so one request yields the whole set.

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

turnID
string
required

The ID of the turn whose checks to list.

Response

200 - application/json

Returns every check attached to the turn named in turnID. Each one asserts on the agent's response text, on whether it routed to a given playbook or workflow, or on whether it called a given tool.

checks
object[]
required
StableTestCheck — see its attributes above
Endpoint
POST
/v1/stable/test-check

Adds a test check to its turn, one assertion about an agent turn, comparing the reply or the behaviour behind it. 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

Response

201 - application/json

Creates one check on the turn named in the body and returns it with its assigned id. Checks hang off agent turns, which are the turns that carry a checkOrder.

check
object
required
StableTestCheck — see its attributes above
Endpoint
POST
/v1/stable/test-check/batch

Adds several test checks to its turn in one request, each taking the fields the single-create call takes. The response carries the created test checks 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

turnID
string
required

The ID of the turn to attach these checks to.

checks
object[]
required

Response

201 - application/json

Creates every check in the request body against the single turn named there and returns them with their assigned IDs. Types can be mixed in one batch, so a response, a routing, and a tool check can all land on the same turn.

checks
object[]
required
StableTestCheck — see its attributes above
Endpoint
GET
/v1/stable/test-check/{checkID}

Returns a single test check by ID, with the fields that define it. A test check is one assertion about an agent turn, comparing the reply or the behaviour behind it.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

checkID
string
required

The ID of the test check 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 check with the turnID it belongs to and the payload for its type: the expected string or judge prompt for a response check, the routing target and whether it should be reached, or the tool and whether it should be called.

check
object
required
StableTestCheck — see its attributes above
Endpoint
PATCH
/v1/stable/test-check/{checkID}

Changes an existing test check in place. The response carries only a confirmation message, so refetch the test check to read its new values.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

checkID
string
required

The ID of the test check 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

Response

200 - application/json

Confirms the check's payload was updated, such as a new judge prompt or a different routing target. The body carries a message only, so read the check back to see what was stored.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/test-check/{checkID}

Deletes a single test check by ID. A test check is one assertion about an agent turn, comparing the reply or the behaviour behind it. The response carries only a confirmation message, so refetch the test checks to see what is left.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

checkID
string
required

The ID of the test check 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

Confirms one assertion was removed from its turn. The body carries a message only, not the turn's remaining checks.

message
string
required

A human-readable message confirming the deletion.

Schemas

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