Batch run transcript evaluations
curl --request POST \
--url https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"projectID": "<string>",
"evaluationIDs": [
"<string>"
],
"transcriptIDs": [
"<string>"
]
}
'import requests
url = "https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue"
payload = {
"projectID": "<string>",
"evaluationIDs": ["<string>"],
"transcriptIDs": ["<string>"]
}
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>',
evaluationIDs: ['<string>'],
transcriptIDs: ['<string>']
})
};
fetch('https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue', 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/queue",
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>',
'evaluationIDs' => [
'<string>'
],
'transcriptIDs' => [
'<string>'
]
]),
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/queue"
payload := strings.NewReader("{\n \"projectID\": \"<string>\",\n \"evaluationIDs\": [\n \"<string>\"\n ],\n \"transcriptIDs\": [\n \"<string>\"\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/queue")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"projectID\": \"<string>\",\n \"evaluationIDs\": [\n \"<string>\"\n ],\n \"transcriptIDs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue")
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 \"evaluationIDs\": [\n \"<string>\"\n ],\n \"transcriptIDs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"transcriptCount": 123,
"evaluationCount": 123,
"warning": {
"type": "quota_exceeded",
"message": "<string>",
"skippedTranscriptIDs": [
"<string>"
]
}
}Batch run transcript evaluations
Queue a batch of evaluations to run for the specified transcripts.
POST
/
v1
/
transcript-evaluation
/
queue
Batch run transcript evaluations
curl --request POST \
--url https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"projectID": "<string>",
"evaluationIDs": [
"<string>"
],
"transcriptIDs": [
"<string>"
]
}
'import requests
url = "https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue"
payload = {
"projectID": "<string>",
"evaluationIDs": ["<string>"],
"transcriptIDs": ["<string>"]
}
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>',
evaluationIDs: ['<string>'],
transcriptIDs: ['<string>']
})
};
fetch('https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue', 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/queue",
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>',
'evaluationIDs' => [
'<string>'
],
'transcriptIDs' => [
'<string>'
]
]),
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/queue"
payload := strings.NewReader("{\n \"projectID\": \"<string>\",\n \"evaluationIDs\": [\n \"<string>\"\n ],\n \"transcriptIDs\": [\n \"<string>\"\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/queue")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"projectID\": \"<string>\",\n \"evaluationIDs\": [\n \"<string>\"\n ],\n \"transcriptIDs\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://analytics-api.voiceflow.com/v1/transcript-evaluation/queue")
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 \"evaluationIDs\": [\n \"<string>\"\n ],\n \"transcriptIDs\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"transcriptCount": 123,
"evaluationCount": 123,
"warning": {
"type": "quota_exceeded",
"message": "<string>",
"skippedTranscriptIDs": [
"<string>"
]
}
}Authorizations
Voiceflow API key
Body
application/json
Response
One or more transcripts were successfully queued for evaluation. A warning will be returned if the per-project queue limit was exceeded including details of all skipped transcripts.
The total number of transcripts queued for one or more evaluation.
The total number of evaluations queued across all transcripts.
Was this page helpful?
⌘I