v3

latestOpenAPI 3.1.02026-07-31350397683.8 KB

Simulations

Update Simulation

update a specific simulation by id.

put/v1/simulation/{simulation_id}

Path parameters

simulation_idinteger required

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

bluejay_as_code_idstring uuid nullable

Stable code-addressable identifier

namestring nullable

updated simulation name

descriptionstring nullable

human‑readable 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 runs (max 500)

hangup_on_transferboolean nullable

whether to hang up the call on transfer

max_call_durationinteger nullable

maximum duration of each call. units specified by max_call_duration_units

max_call_duration_units'minutes' | 'seconds' nullable

units for max_call_duration: 'minutes' or 'seconds'

max_turnsinteger nullable

maximum number of turns per simulation run

ringing_timeoutinteger nullable

ringing timeout in seconds before abandoning

digital_humans_settingsobject nullable

settings for digital humans in the simulation

selected_custom_metricsstring[] nullable

array of custom metric IDs to be saved in settings

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)

outcome_failing_thresholdinteger nullable

outcome score threshold below which the simulation is considered failing (0-99)

outcome_passing_thresholdinteger nullable

outcome score threshold at or above which the simulation is considered passing (1-100)

runs_per_digital_humaninteger nullable

number of simulation runs to execute per digital human

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

tagsstring[] nullable

array of tags for the simulation

pinnedboolean nullable

whether the simulation is pinned

custom_error_enabledboolean nullable

enable custom-error detection for this simulation

custom_error_promptstring nullable

custom-error definition prompt; overrides the org default when set

enable_rerun_failed_test_resultsboolean nullable

per-sim override of the org rerun-on-failure flag

enable_rerun_on_custom_errorboolean nullable

per-sim override of the org rerun-on-custom-error flag

rerun_max_retriesinteger nullable

max same-run reruns of a failed result (1-5)

Response

Successful Response

idinteger nullable

bluejay_as_code_idstring uuid nullable

agent_idinteger required

namestring required

created_atstring date-time nullable

updated_atstring date-time nullable

updated_bystring uuid nullable

created_bystring uuid nullable

settingsobject nullable

type'max_concurrent' | 'parallel' required