Endpoint
GET
/v1/stable/test-turn

Returns every test turn in its test. A test turn is one side of a scripted conversation, either what the user says or the agent reply the checks assert on. 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).

testID
string
required

The ID of the test whose turns to list.

Response

200 - application/json

Returns every turn belonging to the test named in testID. A turn is a scripted user message, an agent turn whose checks assert on what the agent did, or a simulation where an LLM plays the user across a stretch of the conversation.

turns
object[]
required
StableTestTurn — see its attributes above
Endpoint
POST
/v1/stable/test-turn

Adds a test turn to its test, one side of a scripted conversation, either what the user says or the agent reply the checks assert on. 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 turn on the test named in the body and returns it with its assigned id. Where the turn sits in the conversation is held by the test's turnOrder, not by the turn.

turn
object
required
StableTestTurn — see its attributes above
Endpoint
POST
/v1/stable/test-turn/batch

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

testID
string
required

The ID of the test to attach these turns to.

turns
object[]
required

Response

201 - application/json

Creates every turn in the request body against the single test named there and returns them with their assigned IDs. Checks are not part of this call: create them separately against an agent turn's id.

turns
object[]
required
StableTestTurn — see its attributes above
Endpoint
GET
/v1/stable/test-turn/{turnID}

Returns a single test turn by ID, with the fields that define it. A test turn is one side of a scripted conversation, either what the user says or the agent reply the checks assert on.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

turnID
string
required

The ID of the test turn 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 turn: the testID it belongs to, the payload for its type, and, on an agent turn, the checkOrder naming the checks that run against it.

turn
object
required
StableTestTurn — see its attributes above
Endpoint
PATCH
/v1/stable/test-turn/{turnID}

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

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

turnID
string
required

The ID of the test turn 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 turn's payload was updated, along with its checkOrder on an agent turn. The body is a message only, not the revised turn.

message
string
required

A human-readable message confirming the update.

Endpoint
DELETE
/v1/stable/test-turn/{turnID}

Deletes a single test turn by ID. A test turn is one side of a scripted conversation, either what the user says or the agent reply the checks assert on. The response carries only a confirmation message, so refetch the test turns to see what is left.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

turnID
string
required

The ID of the test turn 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 turn was deleted. The body is a message only, so refetch the parent test if you need its current turnOrder.

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.