---
title: "Queue Sms Simulation Run"
method: POST
path: "/v1/queue-sms-simulation-run"
tags: ["Text Simulations"]
---

# Queue Sms Simulation Run

`POST /v1/queue-sms-simulation-run`

## Headers

- `X-API-Key` string, required

## Request body

- SrcTextAgentsSmsTextAgentApiSimulationRunRequest — 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
  - `terminate_overlapping_simulations` boolean, nullable — If true, all overlapping conversations with same pair of phone numbers will be ended
  - `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

- SrcTextAgentsSmsTextAgentApiSimulationRunResponse
  - `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
  - `terminated_conversations` object[], nullable — List of conversations that were terminated due to overlapping phone numbers

## 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)