v7

latestOpenAPI 3.1.02026-08-08356409701.0 KB

Simulations

Create Simulation

Create a new simulation with the provided details.

Returns the simulation id and a status code.

post/v1/create-simulation

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

agent_idstring required

ID of the agent to be used in the simulation

namestring nullable

Name of the simulation

descriptionstring nullable

Description of the simulation

prompt_idstring uuid nullable

Optional default prompt UUID for this simulation

knowledge_base_idstring uuid nullable

Optional default knowledge base UUID for this simulation

max_concurrentinteger nullable

Maximum number of concurrent calls in the simulation (max 500)

hangup_on_transferboolean nullable

Whether to hang up the call on transfer

max_call_durationinteger nullable

Maximum duration of each call (default is 10). Units specified by max_call_duration_units

max_call_duration_units'minutes' | 'seconds' nullable

Units for max_call_duration: 'minutes' (default) or 'seconds'

ringing_timeoutinteger nullable

Ringing timeout in seconds for SIP trunks (default 300s)

selected_custom_metricsstring[] nullable

Custom metric IDs to enable for this simulation

custom_metrics_failing_thresholdinteger nullable

Score threshold below which a custom metric is considered failing (0-100)

custom_metrics_passing_thresholdinteger nullable

Score threshold at or above which a custom metric is considered passing (0-100)

runs_per_digital_humaninteger nullable

Number of simulation runs to execute per digital human (defaults to 1 when omitted)

delay_between_tests_secondsnumber nullable

seconds to wait after a test completes before the next launches (0 = off)

inactivity_timeout_secondsinteger nullable

seconds to wait for an agent reply before ending a text conversation (300-1800 = 5-30 min); defaults to 300 when unset

always_onboolean nullable

When true, simulation has always-on digital humans configured

Response

Successful Response

simulation_idinteger required

ID of the created simulation

statusstring

Status of the response