Update simulation
curl --request PUT \
--url https://app.freyavoice.ai/api/v2/simulations/{simulationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectedPersonaIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"assertions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"maxConcurrentCalls": 500,
"maxCallDurationSeconds": 1830,
"maxRetries": 5,
"runsPerPersona": 25,
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": null,
"averageDurationSeconds": null,
"agentSpeakingPercent": null
}
}
'import requests
url = "https://app.freyavoice.ai/api/v2/simulations/{simulationId}"
payload = {
"name": "<string>",
"description": "<string>",
"tags": ["<string>"],
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectedPersonaIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"assertions": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"maxConcurrentCalls": 500,
"maxCallDurationSeconds": 1830,
"maxRetries": 5,
"runsPerPersona": 25,
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": None,
"averageDurationSeconds": None,
"agentSpeakingPercent": None
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: ['<string>'],
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
selectedPersonaIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
assertions: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
maxConcurrentCalls: 500,
maxCallDurationSeconds: 1830,
maxRetries: 5,
runsPerPersona: 25,
metrics: {
totalRuns: 0,
passedRuns: 0,
failedRuns: 0,
averageLatencyMs: null,
averageDurationSeconds: null,
agentSpeakingPercent: null
}
})
};
fetch('https://app.freyavoice.ai/api/v2/simulations/{simulationId}', 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://app.freyavoice.ai/api/v2/simulations/{simulationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'tags' => [
'<string>'
],
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'selectedPersonaIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'assertions' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'maxConcurrentCalls' => 500,
'maxCallDurationSeconds' => 1830,
'maxRetries' => 5,
'runsPerPersona' => 25,
'metrics' => [
'totalRuns' => 0,
'passedRuns' => 0,
'failedRuns' => 0,
'averageLatencyMs' => null,
'averageDurationSeconds' => null,
'agentSpeakingPercent' => null
]
]),
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://app.freyavoice.ai/api/v2/simulations/{simulationId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"selectedPersonaIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assertions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"maxConcurrentCalls\": 500,\n \"maxCallDurationSeconds\": 1830,\n \"maxRetries\": 5,\n \"runsPerPersona\": 25,\n \"metrics\": {\n \"totalRuns\": 0,\n \"passedRuns\": 0,\n \"failedRuns\": 0,\n \"averageLatencyMs\": null,\n \"averageDurationSeconds\": null,\n \"agentSpeakingPercent\": null\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.freyavoice.ai/api/v2/simulations/{simulationId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"selectedPersonaIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assertions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"maxConcurrentCalls\": 500,\n \"maxCallDurationSeconds\": 1830,\n \"maxRetries\": 5,\n \"runsPerPersona\": 25,\n \"metrics\": {\n \"totalRuns\": 0,\n \"passedRuns\": 0,\n \"failedRuns\": 0,\n \"averageLatencyMs\": null,\n \"averageDurationSeconds\": null,\n \"agentSpeakingPercent\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.freyavoice.ai/api/v2/simulations/{simulationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"selectedPersonaIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assertions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"maxConcurrentCalls\": 500,\n \"maxCallDurationSeconds\": 1830,\n \"maxRetries\": 5,\n \"runsPerPersona\": 25,\n \"metrics\": {\n \"totalRuns\": 0,\n \"passedRuns\": 0,\n \"failedRuns\": 0,\n \"averageLatencyMs\": null,\n \"averageDurationSeconds\": null,\n \"agentSpeakingPercent\": null\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "<string>",
"result": {
"simulation": {
"id": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"settings": {
"maxConcurrentCalls": 1,
"maxCallDurationSeconds": 60,
"maxRetries": 3,
"runsPerPersona": 1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"tags": [],
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": null,
"averageDurationSeconds": null,
"agentSpeakingPercent": null
},
"latestPassRate": 0.5,
"createdBy": "<string>",
"updatedBy": "<string>"
},
"personas": [
{
"id": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": "<string>",
"successCriteria": "<string>",
"systemPrompt": "<string>",
"evaluationPrompt": "<string>",
"tags": [
"<string>"
],
"agentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"simulationVariables": {},
"versionNumber": 123
}
],
"assertions": [
{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"prompt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"contextConfig": {
"includeRoutingEvents": true,
"includeExtractionEvents": true,
"includeToolCalls": true,
"includeOtherEvents": true
}
}
],
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": null,
"averageDurationSeconds": null,
"agentSpeakingPercent": null
},
"publishedVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}Simulations
Update simulation
Updates an existing simulation.
PUT
/
simulations
/
{simulationId}
Update simulation
curl --request PUT \
--url https://app.freyavoice.ai/api/v2/simulations/{simulationId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectedPersonaIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"assertions": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"maxConcurrentCalls": 500,
"maxCallDurationSeconds": 1830,
"maxRetries": 5,
"runsPerPersona": 25,
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": null,
"averageDurationSeconds": null,
"agentSpeakingPercent": null
}
}
'import requests
url = "https://app.freyavoice.ai/api/v2/simulations/{simulationId}"
payload = {
"name": "<string>",
"description": "<string>",
"tags": ["<string>"],
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"selectedPersonaIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"assertions": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"maxConcurrentCalls": 500,
"maxCallDurationSeconds": 1830,
"maxRetries": 5,
"runsPerPersona": 25,
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": None,
"averageDurationSeconds": None,
"agentSpeakingPercent": None
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
tags: ['<string>'],
agentId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
selectedPersonaIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
assertions: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
maxConcurrentCalls: 500,
maxCallDurationSeconds: 1830,
maxRetries: 5,
runsPerPersona: 25,
metrics: {
totalRuns: 0,
passedRuns: 0,
failedRuns: 0,
averageLatencyMs: null,
averageDurationSeconds: null,
agentSpeakingPercent: null
}
})
};
fetch('https://app.freyavoice.ai/api/v2/simulations/{simulationId}', 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://app.freyavoice.ai/api/v2/simulations/{simulationId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'tags' => [
'<string>'
],
'agentId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'selectedPersonaIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'assertions' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'maxConcurrentCalls' => 500,
'maxCallDurationSeconds' => 1830,
'maxRetries' => 5,
'runsPerPersona' => 25,
'metrics' => [
'totalRuns' => 0,
'passedRuns' => 0,
'failedRuns' => 0,
'averageLatencyMs' => null,
'averageDurationSeconds' => null,
'agentSpeakingPercent' => null
]
]),
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://app.freyavoice.ai/api/v2/simulations/{simulationId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"selectedPersonaIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assertions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"maxConcurrentCalls\": 500,\n \"maxCallDurationSeconds\": 1830,\n \"maxRetries\": 5,\n \"runsPerPersona\": 25,\n \"metrics\": {\n \"totalRuns\": 0,\n \"passedRuns\": 0,\n \"failedRuns\": 0,\n \"averageLatencyMs\": null,\n \"averageDurationSeconds\": null,\n \"agentSpeakingPercent\": null\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://app.freyavoice.ai/api/v2/simulations/{simulationId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"selectedPersonaIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assertions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"maxConcurrentCalls\": 500,\n \"maxCallDurationSeconds\": 1830,\n \"maxRetries\": 5,\n \"runsPerPersona\": 25,\n \"metrics\": {\n \"totalRuns\": 0,\n \"passedRuns\": 0,\n \"failedRuns\": 0,\n \"averageLatencyMs\": null,\n \"averageDurationSeconds\": null,\n \"agentSpeakingPercent\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.freyavoice.ai/api/v2/simulations/{simulationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"agentId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"selectedPersonaIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"assertions\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"maxConcurrentCalls\": 500,\n \"maxCallDurationSeconds\": 1830,\n \"maxRetries\": 5,\n \"runsPerPersona\": 25,\n \"metrics\": {\n \"totalRuns\": 0,\n \"passedRuns\": 0,\n \"failedRuns\": 0,\n \"averageLatencyMs\": null,\n \"averageDurationSeconds\": null,\n \"agentSpeakingPercent\": null\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "<string>",
"result": {
"simulation": {
"id": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"settings": {
"maxConcurrentCalls": 1,
"maxCallDurationSeconds": 60,
"maxRetries": 3,
"runsPerPersona": 1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"description": "<string>",
"tags": [],
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": null,
"averageDurationSeconds": null,
"agentSpeakingPercent": null
},
"latestPassRate": 0.5,
"createdBy": "<string>",
"updatedBy": "<string>"
},
"personas": [
{
"id": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"prompt": "<string>",
"successCriteria": "<string>",
"systemPrompt": "<string>",
"evaluationPrompt": "<string>",
"tags": [
"<string>"
],
"agentIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>",
"updatedBy": "<string>",
"simulationVariables": {},
"versionNumber": 123
}
],
"assertions": [
{
"id": "<string>",
"workspaceId": "<string>",
"name": "<string>",
"prompt": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"contextConfig": {
"includeRoutingEvents": true,
"includeExtractionEvents": true,
"includeToolCalls": true,
"includeOtherEvents": true
}
}
],
"metrics": {
"totalRuns": 0,
"passedRuns": 0,
"failedRuns": 0,
"averageLatencyMs": null,
"averageDurationSeconds": null,
"agentSpeakingPercent": null
},
"publishedVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}{
"success": false,
"data": {
"message": "<string>",
"result": "<unknown>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Minimum string length:
1Maximum array length:
50Required string length:
1 - 100Available options:
draft, running, paused, completed Required range:
1 <= x <= 1000Required range:
60 <= x <= 3600Required range:
0 <= x <= 10Required range:
1 <= x <= 50Show child attributes
Show child attributes