---
title: "Queue Simulation Run Endpoint"
method: POST
path: "/v1/queue-simulation-run"
tags: ["Queue Simulation Run"]
---

# Queue Simulation Run Endpoint

`POST /v1/queue-simulation-run`

Queue a simulation run for processing.

## Headers

- `X-API-Key` string, required

## Request body

- union
  - SimulationRunRequestUsingBACId — Queue a simulation run using the simulation's bluejay_as_code_id.
    - `bluejay_as_code_id` string, uuid, required — Bluejay-as-Code ID of the simulation to run
    - `prompt_id` string, uuid, nullable — Prompt UUID associated with this run
    - `knowledge_base_id` string, uuid, nullable — Knowledge base UUID associated with this run
    - `digital_human_ids` string[], nullable — Digital human IDs to be used in the simulation
    - `phone_number` string, nullable — Optional phone number to be used in this simulation run (overrides the agent phone number)
    - `sip_uri` string, nullable — Optional SIP URI to be used in this simulation run (overrides the agent SIP URI)
    - `livekit_agent_name` string, nullable — Optional agent name to be used by user's livekit, an empty string will use the default agent
    - `livekit_metadata` object, nullable — metadata to be passed to the livekit room
    - `pipecat_agent_name` string, nullable — Pipecat agent name
    - `pipecat_agent_configuration` object, nullable — Pipecat agent configuration
    - `pipecat_room_properties` object, nullable — Pipecat room properties
    - `eleven_labs_agent_id` string, nullable — Optional ElevenLabs Convai agent_id (overrides the agent's eleven_labs_agent_id for this run)
    - `retell_agent_id` string, nullable — Optional Retell agent_id (overrides the agent's retell_agent_id for this run)
    - `vapi_assistant_id` string, nullable — Optional Vapi assistant_id (overrides the agent's vapi_assistant_id for this run)
    - `runs_per_digital_human` integer, nullable — Optional per-run override for how many test_results to spawn per selected digital human.
  - SrcApiQueueSimulationRunSimulationRunRequest — Pydantic model for simulation run request
    - `simulation_id` string, required — ID of the simulation to be run
    - `prompt_id` string, uuid, nullable — Prompt UUID associated with this run
    - `knowledge_base_id` string, uuid, nullable — Knowledge base UUID associated with this run
    - `digital_human_ids` string[], nullable — Digital human IDs to be used in the simulation
    - `phone_number` string, nullable — Optional phone number to be used in this simulation run (overrides the agent phone number)
    - `sip_uri` string, nullable — Optional SIP URI to be used in this simulation run (overrides the agent SIP URI)
    - `livekit_agent_name` string, nullable — Optional agent name to be used by user's livekit, an empty string will use the default agent
    - `livekit_metadata` object, nullable — metadata to be passed to the livekit room
    - `pipecat_agent_name` string, nullable — Pipecat agent name
    - `pipecat_agent_configuration` object, nullable — Pipecat agent configuration
    - `pipecat_room_properties` object, nullable — Pipecat room properties
    - `eleven_labs_agent_id` string, nullable — Optional ElevenLabs Convai agent_id (overrides the agent's eleven_labs_agent_id for this run)
    - `retell_agent_id` string, nullable — Optional Retell agent_id (overrides the agent's retell_agent_id for this run)
    - `vapi_assistant_id` string, nullable — Optional Vapi assistant_id (overrides the agent's vapi_assistant_id for this run)
    - `runs_per_digital_human` integer, nullable — Optional per-run override for how many test_results to spawn per selected digital human. Falls back to experiments.settings.runs_per_digital_human, then to 1.

## Response `200`

Successful Response

- SrcApiQueueSimulationRunSimulationRunResponse
  - `simulation_run_id` string, required — ID of the created simulation run
  - `simulation_result_ids` string[], required — IDs of the created simulation results (test results)
  - `agent_id` string, required — ID of the agent associated with the simulation run
  - `status` string — Status of the response

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/getbluejay/apis/bluejay-api.md) · [All operations](https://skmtc.net/getbluejay/apis/bluejay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getbluejay/bluejay-api/revisions/f48cef80963f/schema)