---
title: "Get Simulation Scenario"
method: GET
path: "/admin/simulations/scenario/{engagement_id}"
tags: ["admin", "simulations"]
---

# Get Simulation Scenario

`GET /admin/simulations/scenario/{engagement_id}`

## 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/scenario/{engagement_id}`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Status of a scenario run; relaunches the loop if it died (stale heartbeat).

## Path parameters

- `engagement_id` string, required

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

## Response `200`

Successful Response

- ScenarioStatusResponse
  - `engagement_id` string, required
  - `status` string, required
  - `turns_total` integer, required
  - `turns_sent` integer, required
  - `outcome` string, nullable
  - `reason` string, nullable
  - `error` string, nullable
  - `customer` ScenarioCustomer
    - `name` string, required
    - `meta` string, nullable
  - `interactive` boolean

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