UPupsmith
authenticated
engagements

Read Simulation Scenario

Live scenario status + transcript for a simulation engagement, org-scoped.

Returns scenario status, the interaction transcript used for polling, and the customer-visible event timeline used for rendering. Org isolation comes from read_engagement (the admin status handler it delegates to is org-agnostic by design); it also self-heals a dead server-side loop on each poll.

A plain (optimus) simulation has no scenario run, so the scenario read 404s. Return its transcript anyway with is_scenario_run=False so the UI can render the conversation instead of a blank pane.

get/engagements/{engagement_id}/simulation-scenario

Request

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

Path parameters

engagement_idstring required

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

engagement_idstring required
statusstring required
turns_totalinteger required
turns_sentinteger required
outcomestring nullable
reasonstring nullable
errorstring nullable
interactiveboolean
is_scenario_runboolean

Changes

No recorded changes to this operation across all 1 revision of this API.