Generate evaluator scenarios
Starts background generation of evaluator scenarios for a test agent. Returns a progress ID to poll with the generate-scenarios-progress endpoint.
POST
/
ai
/
tests
/
test_framework
/
v1
/
scenarios
/
generate-bg
Generate evaluator scenarios
curl --request POST \
--url https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"num_scenarios": 5,
"agent_id": 1259,
"extra_instructions": "Focus on angry customers asking about refunds.",
"scenario_type": "workflow",
"generate_expected_outcomes": true
}
'import requests
url = "https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg"
payload = {
"num_scenarios": 5,
"agent_id": 1259,
"extra_instructions": "Focus on angry customers asking about refunds.",
"scenario_type": "workflow",
"generate_expected_outcomes": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
num_scenarios: 5,
agent_id: 1259,
extra_instructions: 'Focus on angry customers asking about refunds.',
scenario_type: 'workflow',
generate_expected_outcomes: true
})
};
fetch('https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg', 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://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg",
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([
'num_scenarios' => 5,
'agent_id' => 1259,
'extra_instructions' => 'Focus on angry customers asking about refunds.',
'scenario_type' => 'workflow',
'generate_expected_outcomes' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg"
payload := strings.NewReader("{\n \"num_scenarios\": 5,\n \"agent_id\": 1259,\n \"extra_instructions\": \"Focus on angry customers asking about refunds.\",\n \"scenario_type\": \"workflow\",\n \"generate_expected_outcomes\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"num_scenarios\": 5,\n \"agent_id\": 1259,\n \"extra_instructions\": \"Focus on angry customers asking about refunds.\",\n \"scenario_type\": \"workflow\",\n \"generate_expected_outcomes\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"num_scenarios\": 5,\n \"agent_id\": 1259,\n \"extra_instructions\": \"Focus on angry customers asking about refunds.\",\n \"scenario_type\": \"workflow\",\n \"generate_expected_outcomes\": true\n}"
response = http.request(request)
puts response.read_body{
"progress_id": "b7e4c1a2-3d4f-5a6b-8c9d-0e1f2a3b4c5d"
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The AI Tests service rejected the request."
}
]
}{
"errors": [
{
"code": "10003",
"title": "Unauthorized",
"detail": "The API key is missing or invalid."
}
]
}{
"errors": [
{
"code": "10005",
"title": "Not Found",
"detail": "The requested resource or URL could not be found."
}
]
}{
"errors": [
{
"code": "10018",
"title": "Unprocessable Entity",
"detail": "Validation failed for the request payload."
}
]
}{
"errors": [
{
"code": "10029",
"title": "Too Many Requests",
"detail": "Too many requests; retry later."
}
]
}{
"errors": [
{
"code": "10063",
"title": "Service Unavailable",
"detail": "The test framework service is temporarily unavailable."
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
How many scenarios to generate.
Optional guidance steering scenario generation.
Whether to generate expected-outcome prompts for the scenarios.
Type of scenario to generate.
Available options:
workflow, red_teaming_voice, red_teaming_text Response
Scenario generation initiated.
Identifier to poll generation progress with.
Was this page helpful?
Generate evaluator scenarios
curl --request POST \
--url https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"num_scenarios": 5,
"agent_id": 1259,
"extra_instructions": "Focus on angry customers asking about refunds.",
"scenario_type": "workflow",
"generate_expected_outcomes": true
}
'import requests
url = "https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg"
payload = {
"num_scenarios": 5,
"agent_id": 1259,
"extra_instructions": "Focus on angry customers asking about refunds.",
"scenario_type": "workflow",
"generate_expected_outcomes": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
num_scenarios: 5,
agent_id: 1259,
extra_instructions: 'Focus on angry customers asking about refunds.',
scenario_type: 'workflow',
generate_expected_outcomes: true
})
};
fetch('https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg', 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://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg",
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([
'num_scenarios' => 5,
'agent_id' => 1259,
'extra_instructions' => 'Focus on angry customers asking about refunds.',
'scenario_type' => 'workflow',
'generate_expected_outcomes' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg"
payload := strings.NewReader("{\n \"num_scenarios\": 5,\n \"agent_id\": 1259,\n \"extra_instructions\": \"Focus on angry customers asking about refunds.\",\n \"scenario_type\": \"workflow\",\n \"generate_expected_outcomes\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"num_scenarios\": 5,\n \"agent_id\": 1259,\n \"extra_instructions\": \"Focus on angry customers asking about refunds.\",\n \"scenario_type\": \"workflow\",\n \"generate_expected_outcomes\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/generate-bg")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"num_scenarios\": 5,\n \"agent_id\": 1259,\n \"extra_instructions\": \"Focus on angry customers asking about refunds.\",\n \"scenario_type\": \"workflow\",\n \"generate_expected_outcomes\": true\n}"
response = http.request(request)
puts response.read_body{
"progress_id": "b7e4c1a2-3d4f-5a6b-8c9d-0e1f2a3b4c5d"
}{
"errors": [
{
"code": "10015",
"title": "Bad Request",
"detail": "The AI Tests service rejected the request."
}
]
}{
"errors": [
{
"code": "10003",
"title": "Unauthorized",
"detail": "The API key is missing or invalid."
}
]
}{
"errors": [
{
"code": "10005",
"title": "Not Found",
"detail": "The requested resource or URL could not be found."
}
]
}{
"errors": [
{
"code": "10018",
"title": "Unprocessable Entity",
"detail": "Validation failed for the request payload."
}
]
}{
"errors": [
{
"code": "10029",
"title": "Too Many Requests",
"detail": "Too many requests; retry later."
}
]
}{
"errors": [
{
"code": "10063",
"title": "Service Unavailable",
"detail": "The test framework service is temporarily unavailable."
}
]
}