Create Case

Create case

curl --request POST \
  --url https://api.goyappr.com/agent-eval/cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Yes path — agreement on first ask",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scenario": "<string>",
  "description": "<string>",
  "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success_criteria": [],
  "max_turns": 20,
  "pass_threshold": 80,
  "agent_overrides": {},
  "tool_policy": "mock",
  "tool_allowlist": []
}
'

import requests

url = "https://api.goyappr.com/agent-eval/cases"

payload = {
    "name": "Yes path — agreement on first ask",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scenario": "<string>",
    "description": "<string>",
    "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "success_criteria": [],
    "max_turns": 20,
    "pass_threshold": 80,
    "agent_overrides": {},
    "tool_policy": "mock",
    "tool_allowlist": []
}
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({
    name: 'Yes path — agreement on first ask',
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    persona_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    scenario: '<string>',
    description: '<string>',
    suite_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    success_criteria: [],
    max_turns: 20,
    pass_threshold: 80,
    agent_overrides: {},
    tool_policy: 'mock',
    tool_allowlist: []
  })
};

fetch('https://api.goyappr.com/agent-eval/cases', 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",
  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([
    'name' => 'Yes path — agreement on first ask',
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'persona_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'scenario' => '<string>',
    'description' => '<string>',
    'suite_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'success_criteria' => [
        
    ],
    'max_turns' => 20,
    'pass_threshold' => 80,
    'agent_overrides' => [
        
    ],
    'tool_policy' => 'mock',
    'tool_allowlist' => [
        
    ]
  ]),
  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.goyappr.com/agent-eval/cases"

	payload := strings.NewReader("{\n  \"name\": \"Yes path — agreement on first ask\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"persona_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scenario\": \"<string>\",\n  \"description\": \"<string>\",\n  \"suite_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"success_criteria\": [],\n  \"max_turns\": 20,\n  \"pass_threshold\": 80,\n  \"agent_overrides\": {},\n  \"tool_policy\": \"mock\",\n  \"tool_allowlist\": []\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.goyappr.com/agent-eval/cases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Yes path — agreement on first ask\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"persona_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scenario\": \"<string>\",\n  \"description\": \"<string>\",\n  \"suite_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"success_criteria\": [],\n  \"max_turns\": 20,\n  \"pass_threshold\": 80,\n  \"agent_overrides\": {},\n  \"tool_policy\": \"mock\",\n  \"tool_allowlist\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.goyappr.com/agent-eval/cases")

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  \"name\": \"Yes path — agreement on first ask\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"persona_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scenario\": \"<string>\",\n  \"description\": \"<string>\",\n  \"suite_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"success_criteria\": [],\n  \"max_turns\": 20,\n  \"pass_threshold\": 80,\n  \"agent_overrides\": {},\n  \"tool_policy\": \"mock\",\n  \"tool_allowlist\": []\n}"

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": [
    {
      "weight": 1,
      "description": "<string>",
      "pattern": "<string>",
      "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>",
    "background_sound_volume": 0.3,
    "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": [],
    "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"
}

{
  "error": "<string>",
  "code": "<string>"
}

POST

agent-eval

cases

Create case

curl --request POST \
  --url https://api.goyappr.com/agent-eval/cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Yes path — agreement on first ask",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scenario": "<string>",
  "description": "<string>",
  "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success_criteria": [],
  "max_turns": 20,
  "pass_threshold": 80,
  "agent_overrides": {},
  "tool_policy": "mock",
  "tool_allowlist": []
}
'

import requests

url = "https://api.goyappr.com/agent-eval/cases"

payload = {
    "name": "Yes path — agreement on first ask",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scenario": "<string>",
    "description": "<string>",
    "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "success_criteria": [],
    "max_turns": 20,
    "pass_threshold": 80,
    "agent_overrides": {},
    "tool_policy": "mock",
    "tool_allowlist": []
}
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({
    name: 'Yes path — agreement on first ask',
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    persona_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    scenario: '<string>',
    description: '<string>',
    suite_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    success_criteria: [],
    max_turns: 20,
    pass_threshold: 80,
    agent_overrides: {},
    tool_policy: 'mock',
    tool_allowlist: []
  })
};

fetch('https://api.goyappr.com/agent-eval/cases', 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",
  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([
    'name' => 'Yes path — agreement on first ask',
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'persona_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'scenario' => '<string>',
    'description' => '<string>',
    'suite_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'success_criteria' => [
        
    ],
    'max_turns' => 20,
    'pass_threshold' => 80,
    'agent_overrides' => [
        
    ],
    'tool_policy' => 'mock',
    'tool_allowlist' => [
        
    ]
  ]),
  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.goyappr.com/agent-eval/cases"

	payload := strings.NewReader("{\n  \"name\": \"Yes path — agreement on first ask\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"persona_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scenario\": \"<string>\",\n  \"description\": \"<string>\",\n  \"suite_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"success_criteria\": [],\n  \"max_turns\": 20,\n  \"pass_threshold\": 80,\n  \"agent_overrides\": {},\n  \"tool_policy\": \"mock\",\n  \"tool_allowlist\": []\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.goyappr.com/agent-eval/cases")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Yes path — agreement on first ask\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"persona_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scenario\": \"<string>\",\n  \"description\": \"<string>\",\n  \"suite_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"success_criteria\": [],\n  \"max_turns\": 20,\n  \"pass_threshold\": 80,\n  \"agent_overrides\": {},\n  \"tool_policy\": \"mock\",\n  \"tool_allowlist\": []\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.goyappr.com/agent-eval/cases")

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  \"name\": \"Yes path — agreement on first ask\",\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"persona_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"scenario\": \"<string>\",\n  \"description\": \"<string>\",\n  \"suite_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"success_criteria\": [],\n  \"max_turns\": 20,\n  \"pass_threshold\": 80,\n  \"agent_overrides\": {},\n  \"tool_policy\": \"mock\",\n  \"tool_allowlist\": []\n}"

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": [
    {
      "weight": 1,
      "description": "<string>",
      "pattern": "<string>",
      "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>",
    "background_sound_volume": 0.3,
    "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": [],
    "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"
}

{
  "error": "<string>",
  "code": "<string>"
}

A case is the runnable unit of agent eval — persona + agent + scenario + success criteria. Suites are optional; a case with suite_id: null is an ad-hoc case you can run on its own.

Worked example

{
  "name": "Yes path — caller agrees on first ask",
  "agent_id": "...",
  "persona_id": "...",
  "scenario": "The persona is responding to a missed call from your business about their recent inquiry. They have 5 minutes to talk.",
  "success_criteria": [
    {
      "type": "must_say",
      "pattern": "would Tuesday at 3pm work for you",
      "weight": 1
    },
    {
      "type": "must_call_tool",
      "tool_name": "bookAppointment",
      "weight": 2
    },
    {
      "type": "must_not_say",
      "pattern": "guarantee",
      "weight": 1
    }
  ],
  "max_turns": 20,
  "pass_threshold": 80,
  "tool_policy": "mock"
}

Assertion shape

Each entry in success_criteria is one assertion with these fields:

Field	Required for	Notes
`type`	all	One of `must_say`, `must_not_say`, `must_call_tool`, `must_reach_node`, `custom_llm_judge`.
`weight`	optional	Relative weight in the case score (defaults to `1`).
`pattern`	`must_say` / `must_not_say`	Regex evaluated against the full agent transcript, case-insensitive. Plain substrings work — they’re valid regex. Escape literal punctuation (e.g. `goodbye\\?`).
`tool_name`	`must_call_tool`	The tool name the agent must invoke at least once during the run.
`args_match`	`must_call_tool` (optional)	Object whose keys must equal the values in the tool’s invocation args. Use `"$present"` to assert “key exists with any non-null value”.
`node_id`	`must_reach_node`	Flow node id the run must enter. Silently fails for prompt-mode agents — use this only on flow agents.
`rubric`	`custom_llm_judge`	Natural-language description of what a successful run looks like. Engine stub in v1 — returns `passed=false, reason='not_implemented'` until v1.1 ships full LLM-as-judge.
`description`	optional	Human-readable note shown in the dashboard alongside this assertion.

Choosing `tool_policy`

Policy	When to use
`mock` (default)	Your CI suite. Tools never fire — every call returns a synthetic success result. Free, deterministic.
`real`	One-off pre-prod check that the full integration works. Hits real systems; charges real third-party costs.
`allowlist`	Hybrid — list specific tools in `tool_allowlist`. The named tools fire for real, the rest mock. Useful when you want to validate one new tool but not regenerate calendar holds for the whole suite.

Authorizations

Authorization

string

header

required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json

name

string

required

Example:

"Yes path — agreement on first ask"

agent_id

string<uuid>

required

persona_id

string<uuid>

required

scenario

string

required

description

string

suite_id

string<uuid> | null

success_criteria

object[]

Show child attributes

max_turns

integer

default:20

Required range: 1 <= x <= 100

pass_threshold

number

default:80

Required range: 0 <= x <= 100

agent_overrides

object | null

tool_policy

enum<string>

default:mock

Available options:

mock,

real,

allowlist

tool_allowlist

string[]

Response

Case created

A specific eval scenario — persona + target agent + scenario + success criteria.

string<uuid>

required

company_id

string<uuid>

required

agent_id

string<uuid>

required

Agent under test. Full agent record is expanded inline as agent in API responses.

persona_id

string<uuid>

required

name

string

required

Example:

"Yes path — caller agrees on first ask"

scenario

string

required

Free-form one-paragraph framing the persona LLM is given on top of its identity. Describe the situation that prompted the call.

Example:

"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

object[]

required

Array of assertions evaluated after the run completes.

Show child attributes

max_turns

integer

default:20

required

Hard cap on conversation turns. Hitting this terminates the run with termination_reason='max_turns'.

Required range: 1 <= x <= 100

pass_threshold

number

default:80

required

Weighted-score threshold (0-100) for pass_fail=true.

Required range: 0 <= x <= 100

tool_policy

enum<string>

default:mock

required

How the agent's tools behave during the run. mock (default): every tool call returns a synthetic success result the worker fabricates from the tool's declared output schema. real: tools fire for real (charges real money, hits real systems). allowlist: tools whose name appears in tool_allowlist fire for real, the rest return mock results.

Available options:

mock,

real,

allowlist

created_at

string<date-time>

required

agent

object

Show child attributes

persona

object

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

suite_id

string<uuid> | null

Optional parent suite. When null, the case is ad-hoc — runnable on its own but not part of a regression sweep.

description

string | null

agent_overrides

object | null

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.

tool_allowlist

string[]

Used only when tool_policy='allowlist'. List of tool names (camelCase) that should fire for real.

updated_at

string<date-time>

deleted_at

string<date-time> | null

List Cases Get Case

API Reference

Billing

Agents

Flow Agents

Integrations

Tools

Phone Numbers

SIP Endpoints

Calls

Do Not Call

Call Windows

Dispositions

Leads

Lead Tags

Shared Links

Agent Eval

Worked example

Assertion shape

Choosing `tool_policy`

Authorizations

Body

Response

​Worked example

​Assertion shape

​Choosing tool_policy

Authorizations

Body

Response

Worked example

Assertion shape

Choosing `tool_policy`