Endpoint
GET
/v1/stable/test

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.

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

Response

200 - application/json

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.

tests
object[]
required
StableTest — see its attributes above
Endpoint
POST
/v1/stable/test

Adds a test to the environment, a scripted conversation replayed against the agent. 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

name
string
required
settings
object

Response

201 - application/json

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.

test
object
required
StableTest — see its attributes above
Endpoint
POST
/v1/stable/test/batch

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.

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

tests
object[]
required
StableTestCreateRequest — see its attributes above

Response

201 - application/json

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.

tests
object[]
required
StableTest — see its attributes above
Endpoint
GET
/v1/stable/test/{testID}

Returns a single test by ID, with the fields that define it. A test is a scripted conversation replayed against the agent.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

testID
string
required

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

test
object
required
StableTest — see its attributes above
Endpoint
PATCH
/v1/stable/test/{testID}

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

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

testID
string
required

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

name
string
settings
object
turnOrder
string[]

The IDs of the test's turns, in execution order.

Response

200 - application/json

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.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/test/{testID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

testID
string
required

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

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.