Skip to main content
POST
Create check

Authorizations

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

Body

application/json
type
enum<string>
required

Identifies a check that judges the agent's response text against expected criteria.

Available options:
response
turnID
string
required

The ID of the turn this check belongs to.

payload
object
required

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