Skip to main content
POST
Create evaluation

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Query Parameters

projectID
string
required

The ID of the project to operate on.

Body

application/json
type
enum<string>
required

Identifies an evaluation that produces a true/false result.

Available options:
boolean
truePrompt
string
required

The criteria describing when the evaluator should return true.

falsePrompt
string
required

The criteria describing when the evaluator should return false.

name
string
required
prompt
string
required

The criteria the evaluator uses to judge a transcript.

enabled
boolean
required

Whether this evaluation runs automatically against new transcripts.

description
string | null

A human-readable description of what this evaluation measures.

Response

201 - application/json

Creates the evaluation and returns it with its assigned id. No transcript is scored yet: results come from running it against a transcript, or automatically on new transcripts when enabled is true.

evaluation
object
required