authenticated
engagements

End Simulation Scenario

End an interactive run, org-scoped.

An interactive run has no loop to reach a terminal state on its own, so the user says when they're done, marking the run they drove terminal.

post/engagements/{engagement_id}/simulation-scenario/end

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.