Create transcript evaluation
curl --request POST \
--url https://analytics-api.voiceflow.com/v1/transcript-evaluation \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"projectID": "<string>",
"name": "<string>",
"enabled": true,
"prompt": "<string>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"description": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
}
}
'import requests
url = "https://analytics-api.voiceflow.com/v1/transcript-evaluation"
payload = {
"projectID": "<string>",
"name": "<string>",
"enabled": True,
"prompt": "<string>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"description": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
}
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
projectID: '<string>',
name: '<string>',
enabled: true,
prompt: '<string>',
type: 'boolean',
truePrompt: '<string>',
falsePrompt: '<string>',
description: '<string>',
settings: {
realtime: {voice: '<string>', eagerness: '<string>'},
maxTokens: 123,
temperature: 123
}
})
};
fetch('https://analytics-api.voiceflow.com/v1/transcript-evaluation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://analytics-api.voiceflow.com/v1/transcript-evaluation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'projectID' => '<string>',
'name' => '<string>',
'enabled' => true,
'prompt' => '<string>',
'type' => 'boolean',
'truePrompt' => '<string>',
'falsePrompt' => '<string>',
'description' => '<string>',
'settings' => [
'realtime' => [
'voice' => '<string>',
'eagerness' => '<string>'
],
'maxTokens' => 123,
'temperature' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://analytics-api.voiceflow.com/v1/transcript-evaluation"
payload := strings.NewReader("{\n \"projectID\": \"<string>\",\n \"name\": \"<string>\",\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"type\": \"boolean\",\n \"truePrompt\": \"<string>\",\n \"falsePrompt\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"realtime\": {\n \"voice\": \"<string>\",\n \"eagerness\": \"<string>\"\n },\n \"maxTokens\": 123,\n \"temperature\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://analytics-api.voiceflow.com/v1/transcript-evaluation")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"projectID\": \"<string>\",\n \"name\": \"<string>\",\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"type\": \"boolean\",\n \"truePrompt\": \"<string>\",\n \"falsePrompt\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"realtime\": {\n \"voice\": \"<string>\",\n \"eagerness\": \"<string>\"\n },\n \"maxTokens\": 123,\n \"temperature\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://analytics-api.voiceflow.com/v1/transcript-evaluation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"projectID\": \"<string>\",\n \"name\": \"<string>\",\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"type\": \"boolean\",\n \"truePrompt\": \"<string>\",\n \"falsePrompt\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"realtime\": {\n \"voice\": \"<string>\",\n \"eagerness\": \"<string>\"\n },\n \"maxTokens\": 123,\n \"temperature\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "<string>",
"projectID": "<string>",
"name": "<string>",
"description": "<string>",
"default": true,
"enabled": true,
"averageCost": 123,
"prompt": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
},
"systemTag": "<string>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>"
}
}Create transcript evaluation
Create a new transcript evaluation definition.
POST
/
v1
/
transcript-evaluation
Create transcript evaluation
curl --request POST \
--url https://analytics-api.voiceflow.com/v1/transcript-evaluation \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"projectID": "<string>",
"name": "<string>",
"enabled": true,
"prompt": "<string>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"description": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
}
}
'import requests
url = "https://analytics-api.voiceflow.com/v1/transcript-evaluation"
payload = {
"projectID": "<string>",
"name": "<string>",
"enabled": True,
"prompt": "<string>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>",
"description": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
}
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
projectID: '<string>',
name: '<string>',
enabled: true,
prompt: '<string>',
type: 'boolean',
truePrompt: '<string>',
falsePrompt: '<string>',
description: '<string>',
settings: {
realtime: {voice: '<string>', eagerness: '<string>'},
maxTokens: 123,
temperature: 123
}
})
};
fetch('https://analytics-api.voiceflow.com/v1/transcript-evaluation', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://analytics-api.voiceflow.com/v1/transcript-evaluation",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'projectID' => '<string>',
'name' => '<string>',
'enabled' => true,
'prompt' => '<string>',
'type' => 'boolean',
'truePrompt' => '<string>',
'falsePrompt' => '<string>',
'description' => '<string>',
'settings' => [
'realtime' => [
'voice' => '<string>',
'eagerness' => '<string>'
],
'maxTokens' => 123,
'temperature' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://analytics-api.voiceflow.com/v1/transcript-evaluation"
payload := strings.NewReader("{\n \"projectID\": \"<string>\",\n \"name\": \"<string>\",\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"type\": \"boolean\",\n \"truePrompt\": \"<string>\",\n \"falsePrompt\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"realtime\": {\n \"voice\": \"<string>\",\n \"eagerness\": \"<string>\"\n },\n \"maxTokens\": 123,\n \"temperature\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://analytics-api.voiceflow.com/v1/transcript-evaluation")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"projectID\": \"<string>\",\n \"name\": \"<string>\",\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"type\": \"boolean\",\n \"truePrompt\": \"<string>\",\n \"falsePrompt\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"realtime\": {\n \"voice\": \"<string>\",\n \"eagerness\": \"<string>\"\n },\n \"maxTokens\": 123,\n \"temperature\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://analytics-api.voiceflow.com/v1/transcript-evaluation")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"projectID\": \"<string>\",\n \"name\": \"<string>\",\n \"enabled\": true,\n \"prompt\": \"<string>\",\n \"type\": \"boolean\",\n \"truePrompt\": \"<string>\",\n \"falsePrompt\": \"<string>\",\n \"description\": \"<string>\",\n \"settings\": {\n \"realtime\": {\n \"voice\": \"<string>\",\n \"eagerness\": \"<string>\"\n },\n \"maxTokens\": 123,\n \"temperature\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "<string>",
"projectID": "<string>",
"name": "<string>",
"description": "<string>",
"default": true,
"enabled": true,
"averageCost": 123,
"prompt": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
},
"systemTag": "<string>",
"type": "boolean",
"truePrompt": "<string>",
"falsePrompt": "<string>"
}
}Authorizations
Voiceflow API key
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
Create a binary evaluation.
ID of the target Voiceflow project.
Required string length:
24Name of the evaluation.
Required string length:
1 - 100When enabled, evaluations will be run on every new transcript.
This prompt describes how the LLM should apply this evaluation.
Required string length:
1 - 10000The type of binary evaluations.
Available options:
boolean This prompt describes which transcripts should evaluate as 'true'.
Required string length:
1 - 10000This prompt describes which transcripts should evaluate as 'false'.
Required string length:
1 - 10000Description of the evaluation.
Maximum string length:
250The model settings passed when invoking this evaluation.
Hide child attributes
Hide child attributes
Available options:
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-realtime, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.1, voiceflow-flash-4.1, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnet Available options:
minimal, low, medium, high Response
201 - application/json
- Option 1
- Option 2
- Option 3
- Option 4
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
gpt-3.5-turbo-1106, gpt-3.5-turbo, gpt-4, gpt-4o, gpt-4o-mini, gpt-4.1-2025-04-14, gpt-4.1-mini-2025-04-14, gpt-4.1-nano-2025-04-14, gpt-o3-mini, o3-2025-04-16, o4-mini-2025-04-16, gpt-5, gpt-5-mini, gpt-5-nano, gpt-5.2, gpt-5.4, gpt-5.4-mini, gpt-5.5, gpt-realtime, claude-4-opus, claude-4-sonnet, claude-4.5-sonnet, claude-4.6-sonnet, claude-4.5-haiku, claude-4.5-opus, claude-4.7-opus, bedrock-claude-4-sonnet, bedrock-claude-4.5-sonnet, bedrock-claude-4.6-sonnet, bedrock-claude-5-sonnet, bedrock-claude-4.5-haiku, bedrock-claude-4.5-opus, bedrock-claude-4.7-opus, bedrock-claude-4.8-opus, voiceflow-core-4.0, voiceflow-core-4.1, voiceflow-flash-4.1, gemini-2.5-pro, gemini-2.5-flash, gemini-live-2.5-flash, gemini-3-flash, gemini-3.5-flash, gemini-3.1-pro, gpt-oss-20b, gpt-oss-120b, llama-guard-4, llama-3.1-instant, llama-3.3-versatile, qwen3.6-27b, gemini-flash-2, gpt-4-turbo, claude-3.5-haiku, claude-3-opus, claude-3.7-sonnet, claude-v2, llama-3.2-1b-preview, gemini-pro-1.5, claude-3-haiku, claude-3-sonnet, text-davinci-003, claude-v1, claude-instant-v1, deep-seek-r1-distill-llama-70B, claude-3.5-sonnet Available options:
minimal, low, medium, high Available options:
boolean Was this page helpful?
⌘I