curl --request GET \
--url https://api.goyappr.com/agent-eval/cases/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/agent-eval/cases/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/agent-eval/cases/{id}', 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.goyappr.com/agent-eval/cases/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.goyappr.com/agent-eval/cases/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.goyappr.com/agent-eval/cases/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/agent-eval/cases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Yes path — caller agrees on first ask",
"scenario": "The persona is responding to a missed call from your business about their recent inquiry. They have time to talk for 5 minutes.",
"success_criteria": [
{
"type": "must_say",
"kind": "must_say",
"weight": 1,
"description": "<string>",
"pattern": "<string>",
"phrase": "<string>",
"match_type": "substring",
"case_sensitive": false,
"tool_name": "<string>",
"args_match": {},
"node_id": "<string>",
"rubric": "<string>"
}
],
"max_turns": 20,
"pass_threshold": 80,
"tool_policy": "mock",
"created_at": "2023-11-07T05:31:56Z",
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "prompt",
"flow_config": {
"nodes": [
{
"id": "<string>",
"type": "start",
"name": "<string>",
"position": {
"x": 123,
"y": 123
},
"agent_speaks_first": true,
"greeting": "<string>",
"is_literal": false,
"next_step_id": "<string>",
"auto_advance": true
}
],
"flow_config_version": "1",
"metadata": {
"custom_metadata_keys": [
"<string>"
]
}
},
"system_prompt": "<string>",
"description": "<string>",
"voice": "Michal",
"background_sound": "call_center",
"background_sound_volume": 0.3,
"language": "he",
"temperature": 1,
"greeting_message": "<string>",
"agent_speaks_first": true,
"vad_stop_secs": 0.5,
"vad_start_secs": 0.2,
"vad_confidence": 0.7,
"silence_timeout_secs": 60,
"max_continuous_speech_secs": 120,
"max_call_duration_secs": 600,
"lead_memory_enabled": true,
"is_active": true,
"webhook_url": "<string>",
"webhook_events": [
"call.started"
],
"webhook_headers": {
"Authorization": "Bearer sk_live_…",
"X-Source": "yappr"
},
"extraction_parameters": [
{
"name": "customerName",
"description": "The caller's full name as mentioned during the conversation"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"persona": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Frustrated tenant",
"identity_prompt": "You are a 38-year-old tenant calling about a leaking pipe in your kitchen. You're frustrated because this is the third time you've reported it.",
"language": "en",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"behavior_traits": {
"patience": "low",
"verbosity": "chatty",
"cooperation": "cooperative",
"interruption_tendency": "occasional",
"goal": "Get a maintenance technician scheduled today"
},
"voice_config": {},
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"agent_overrides": {},
"tool_allowlist": [],
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}Get Case
curl --request GET \
--url https://api.goyappr.com/agent-eval/cases/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.goyappr.com/agent-eval/cases/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.goyappr.com/agent-eval/cases/{id}', 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.goyappr.com/agent-eval/cases/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.goyappr.com/agent-eval/cases/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.goyappr.com/agent-eval/cases/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.goyappr.com/agent-eval/cases/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Yes path — caller agrees on first ask",
"scenario": "The persona is responding to a missed call from your business about their recent inquiry. They have time to talk for 5 minutes.",
"success_criteria": [
{
"type": "must_say",
"kind": "must_say",
"weight": 1,
"description": "<string>",
"pattern": "<string>",
"phrase": "<string>",
"match_type": "substring",
"case_sensitive": false,
"tool_name": "<string>",
"args_match": {},
"node_id": "<string>",
"rubric": "<string>"
}
],
"max_turns": 20,
"pass_threshold": 80,
"tool_policy": "mock",
"created_at": "2023-11-07T05:31:56Z",
"agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "prompt",
"flow_config": {
"nodes": [
{
"id": "<string>",
"type": "start",
"name": "<string>",
"position": {
"x": 123,
"y": 123
},
"agent_speaks_first": true,
"greeting": "<string>",
"is_literal": false,
"next_step_id": "<string>",
"auto_advance": true
}
],
"flow_config_version": "1",
"metadata": {
"custom_metadata_keys": [
"<string>"
]
}
},
"system_prompt": "<string>",
"description": "<string>",
"voice": "Michal",
"background_sound": "call_center",
"background_sound_volume": 0.3,
"language": "he",
"temperature": 1,
"greeting_message": "<string>",
"agent_speaks_first": true,
"vad_stop_secs": 0.5,
"vad_start_secs": 0.2,
"vad_confidence": 0.7,
"silence_timeout_secs": 60,
"max_continuous_speech_secs": 120,
"max_call_duration_secs": 600,
"lead_memory_enabled": true,
"is_active": true,
"webhook_url": "<string>",
"webhook_events": [
"call.started"
],
"webhook_headers": {
"Authorization": "Bearer sk_live_…",
"X-Source": "yappr"
},
"extraction_parameters": [
{
"name": "customerName",
"description": "The caller's full name as mentioned during the conversation"
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"persona": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Frustrated tenant",
"identity_prompt": "You are a 38-year-old tenant calling about a leaking pipe in your kitchen. You're frustrated because this is the third time you've reported it.",
"language": "en",
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"behavior_traits": {
"patience": "low",
"verbosity": "chatty",
"cooperation": "cooperative",
"interruption_tendency": "occasional",
"goal": "Get a maintenance technician scheduled today"
},
"voice_config": {},
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
},
"suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"description": "<string>",
"agent_overrides": {},
"tool_allowlist": [],
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}agent and persona expanded inline.Authorizations
Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.
Path Parameters
Response
Case
A specific eval scenario — persona + target agent + scenario + success criteria.
Agent under test. Full agent record is expanded inline as agent in API responses.
"Yes path — caller agrees on first ask"
Free-form one-paragraph framing the persona LLM is given on top of its identity. Describe the situation that prompted the call.
"The persona is responding to a missed call from your business about their recent inquiry. They have time to talk for 5 minutes."
Array of assertions evaluated after the run completes.
Show child attributes
Show child attributes
Hard cap on conversation turns. Hitting this terminates the run with termination_reason='max_turns'.
1 <= x <= 100Weighted-score threshold (0-100) for pass_fail=true.
0 <= x <= 100How the agent's tools behave during the run. Applies to BOTH agent types — a flow agent's tool_call steps and the tools attached to a single-prompt agent, which the model calls directly. mock (default): webhook tools make no request — each returns the fixed synthetic result {"success": true, "status_code": 200}. The canonical request body is still assembled (so argument-resolution bugs still surface, and must_call_tool + args_match still assert against it), but target validation and the network hop are skipped, so mock does not prove the endpoint is reachable or acceptable. Because the synthetic body is fixed, a step whose transitions branch on the response CONTENT always takes its success edge under mock. real: tools fire for real (charges real money, hits real systems). allowlist: webhook tools matching an entry in tool_allowlist fire for real, the rest return the same synthetic success. Note that allowlist differentiates webhook tools ONLY — steps calling a connected app (Google Calendar, Gmail) dispatch for real under both real and allowlist, because those are gated separately and have no per-tool name to match on. Use mock to hold those back too. Hang-up and transfer tools are policy-independent: they make no request, so in a run they simply end it (a transfer never places a call to its destination).
mock, real, allowlist Show child attributes
Show child attributes
Reusable caller archetype consumed by eval cases. The identity_prompt plus behavior_traits shape how the persona LLM responds; the same persona can be reused across many cases.
Show child attributes
Show child attributes
Optional parent suite. When null, the case is ad-hoc — runnable on its own but not part of a regression sweep.
Optional per-case overrides applied to the agent's saved config at run time (e.g. a different system_prompt or flow_config for A/B testing). Same shape as the agent record. The agent on disk is never mutated. Configuration only: the identity fields id, company_id, company_timezone, tools and flow_tools are stored but ignored at run time — a run always executes as the agent's own workspace, with the tools that workspace resolved.
Used only when tool_policy='allowlist'. Entries match a tool's id or its name, exactly and case-sensitively. Prefer ids: tool names are not unique within a company, so a name arms every tool that shares it. An entry that matches nothing is mocked rather than fired — a typo fails safe, and shows in the run trace as dispatched: false.