v3

latestOpenAPI 3.1.02026-07-31350397683.8 KB

Simulations

Get Simulation

Get a specific simulation by ID.

get/v1/simulation/{simulation_id}

Path parameters

simulation_idinteger required

Headers

X-API-Keystring required

API key required to authenticate requests.

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

max_concurrentinteger nullable

max_turnsinteger nullable

ringing_timeoutinteger nullable

inactivity_timeout_secondsinteger nullable

tagsstring[] nullable

descriptionstring nullable

pinnedboolean nullable

always_onboolean nullable