Skip to content

Dry-run one case, saved or ad-hoc

POST
/voice/agents/{agent_id}/test

SPENDS NOTHING. One dry run, from a saved case (test_case_id) or an ad-hoc input (input_message), never both.

Returns the run row with the composed preview: the instruction stack the agent would receive, the tools it could reach for and the grounding it could cite, judged against the assertion. No model call, no call placed, no message sent. triggered_by defaults to the key’s identity.

Authorizations

Parameters

Path Parameters

agent_id
required

Voice agent id.

string

Voice agent id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

One dry run. Exactly one source: test_case_id (a saved case) or input_message (ad-hoc). Never calls a model, never places a call, never sends a message - it resolves what the agent WOULD receive and reach for.

object
assertion_config
Any of:
object
key
additional properties
any
assertion_type
Any of:
string
Allowed values: exact contains not_contains expects_tool refuses cites_collection llm_judge
channel
Any of:
string
Allowed values: chat inbound outbound
expected_output
Any of:
input_context
Any of:
object
key
additional properties
any
input_message
Any of:
string
>= 1 characters
mode
Any of:
string
Allowed values: preview dry_run
test_case_id
Any of:
string
triggered_by
Any of:
string

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string