---
title: "Create Simulation"
method: POST
path: "/admin/simulations/"
tags: ["admin", "simulations"]
---

# Create Simulation

`POST /admin/simulations/`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/simulations/`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Create a simulation engagement for testing agent flows with mock data.

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Request body

- CreateSimulationRequest
  - `organization_id` string, required
  - `agent_id` string, required
  - `contact_id` string, nullable
  - `campaign_id` string, nullable
  - `targeting_rules` object[], nullable
  - `synthetic_lead` boolean
  - `lead_intake` string, nullable
  - `lead_source` string
  - `lead_name` string, nullable
  - `model` string, nullable
  - `variables` object, nullable
  - `runner_version` string, nullable
  - `include_engagement_history` boolean
  - `variant_id` string, nullable
  - `opener` string, nullable
  - `contact_method_id` string, nullable

## Response `200`

Successful Response

- SimulationResponse
  - `engagement_id` string, required
  - `organization_id` string, required
  - `agent_v2_id` string, nullable
  - `status` string, required
  - `is_simulated` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)