Simulations

Get Simulation

Changed on

Get a specific simulation by ID.

get/v1/simulation/{simulation_id}

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/simulation/{simulation_id}
  • Auth
    HTTPBearer (a scheme the document does not define)

Path parameters

simulation_idinteger required

Headers

X-Organization-Idstring
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

Changes

  • aa501502e1fcRevision changes
    • info

      added the new optional header request parameter X-Organization-Id

  • 4309a961859bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status