Improve evaluator scenarios
Starts an interactive session that improves selected evaluator scenarios from a natural-language instruction. Returns a progress ID to poll with the improve-scenarios-progress endpoint.
POST
/
ai
/
tests
/
test_framework
/
v1
/
scenarios
/
scenario-agent
Improve evaluator scenarios
curl --request POST \
--url https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_message": "Make the callers ask about damaged packaging too.",
"scenarios": "all",
"agent_id": 1259,
"apply_changes": true
}
'import requests
url = "https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent"
payload = {
"user_message": "Make the callers ask about damaged packaging too.",
"scenarios": "all",
"agent_id": 1259,
"apply_changes": 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({
user_message: 'Make the callers ask about damaged packaging too.',
scenarios: 'all',
agent_id: 1259,
apply_changes: true
})
};
fetch('https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent', 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/scenario-agent",
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([
'user_message' => 'Make the callers ask about damaged packaging too.',
'scenarios' => 'all',
'agent_id' => 1259,
'apply_changes' => 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/scenario-agent"
payload := strings.NewReader("{\n \"user_message\": \"Make the callers ask about damaged packaging too.\",\n \"scenarios\": \"all\",\n \"agent_id\": 1259,\n \"apply_changes\": 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/scenario-agent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_message\": \"Make the callers ask about damaged packaging too.\",\n \"scenarios\": \"all\",\n \"agent_id\": 1259,\n \"apply_changes\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent")
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 \"user_message\": \"Make the callers ask about damaged packaging too.\",\n \"scenarios\": \"all\",\n \"agent_id\": 1259,\n \"apply_changes\": true\n}"
response = http.request(request)
puts response.read_body{
"progress_id": "c8f5d2b3-4e5f-6a7b-9c0d-1f2a3b4c5d6e",
"session_id": 417
}{
"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
What the assistant should improve about the selected scenarios.
Scenario IDs to improve, or the literal string 'all'.
Show child attributes
Show child attributes
Was this page helpful?
Improve evaluator scenarios
curl --request POST \
--url https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_message": "Make the callers ask about damaged packaging too.",
"scenarios": "all",
"agent_id": 1259,
"apply_changes": true
}
'import requests
url = "https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent"
payload = {
"user_message": "Make the callers ask about damaged packaging too.",
"scenarios": "all",
"agent_id": 1259,
"apply_changes": 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({
user_message: 'Make the callers ask about damaged packaging too.',
scenarios: 'all',
agent_id: 1259,
apply_changes: true
})
};
fetch('https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent', 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/scenario-agent",
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([
'user_message' => 'Make the callers ask about damaged packaging too.',
'scenarios' => 'all',
'agent_id' => 1259,
'apply_changes' => 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/scenario-agent"
payload := strings.NewReader("{\n \"user_message\": \"Make the callers ask about damaged packaging too.\",\n \"scenarios\": \"all\",\n \"agent_id\": 1259,\n \"apply_changes\": 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/scenario-agent")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_message\": \"Make the callers ask about damaged packaging too.\",\n \"scenarios\": \"all\",\n \"agent_id\": 1259,\n \"apply_changes\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telnyx.com/v2/ai/tests/test_framework/v1/scenarios/scenario-agent")
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 \"user_message\": \"Make the callers ask about damaged packaging too.\",\n \"scenarios\": \"all\",\n \"agent_id\": 1259,\n \"apply_changes\": true\n}"
response = http.request(request)
puts response.read_body{
"progress_id": "c8f5d2b3-4e5f-6a7b-9c0d-1f2a3b4c5d6e",
"session_id": 417
}{
"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."
}
]
}