Skip to main content
POST /v2/queue-simulation-run
Queues a run of a simulation and returns the run ID. The calls run after the response. Poll Retrieve Simulation Results for results.
  • Send simulation_id, or the bluejay_as_code_id of the simulation.
  • If you omit digital_human_ids, all Digital Humans in the simulation run.
  • runs_per_digital_human overrides the simulation setting for this run. The default is 1.
  • phone_number, sip_uri, and the provider agent IDs override the agent values for this run only.
  • prompt_id is deprecated. Use agent_version_id. If you send both and they differ, the response is 400.
  • ci tags the run with the pipeline that queued it. See CI/CD.

SMS agents

An SMS agent runs through this endpoint too: Bluejay texts it instead of calling it.
  • Your organization needs SMS testing enabled. Otherwise the response is 403 sms_testing_not_enabled.
  • Every Digital Human in the run needs a phone number. Otherwise the response is 400.
  • If terminate_overlapping_simulations is true, Bluejay ends running conversations that use the same pair of phone numbers.
  • phone_number, sip_uri, and the provider agent IDs do not apply.

Headers

Request body

Response

Status codes

Example request

Example response

200
Last modified on November 16, 2026