Text Simulations

Queue Sms Simulation Run

Changed on
post/v1/queue-sms-simulation-run

Request

  • Base URL
    https://api.getbluejay.ai
  • URL
    https://api.getbluejay.ai/v1/queue-sms-simulation-run
  • Auth
    HTTPBearer (a scheme the document does not define)

Headers

X-Organization-Idstring
X-API-Keystring required

API key required to authenticate requests.

Request body

simulation_idstring required

ID of the simulation to be run

prompt_idstring uuid nullable

Deprecated. Use agent_version_id. Same uuid, still works.

agent_version_idstring uuid nullable

Agent version UUID associated with this run

knowledge_base_idstring uuid nullable

Knowledge base UUID associated with this run

digital_human_idsstring[] nullable

Digital human IDs to be used in the simulation

terminate_overlapping_simulationsboolean nullable

If true, all overlapping conversations with same pair of phone numbers will be ended

runs_per_digital_humaninteger nullable

Optional per-run override for how many conversations to spawn per selected digital human. Falls back to experiments.settings.runs_per_digital_human, then to 1.

Response

Successful Response

simulation_run_idstring required

ID of the created simulation run

simulation_result_idsstring[] required

IDs of the created simulation results (test results)

agent_idstring required

ID of the agent associated with the simulation run

statusstring

Status of the response

terminated_conversationsobject[] nullable

List of conversations that were terminated due to overlapping phone numbers

Changes