Start Simulation Scenario

Start a fire-and-forget, LLM-driven multi-turn simulation; poll GET /scenario/{id} for status.

post/admin/simulations/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

organization-idstring nullable

timezonestring

x-user-idstring nullable

x-actor-emailstring nullable

x-request-sourcestring nullable

x-operation-idstring nullable

x-commit-messagestring nullable

x-confirmation-idstring nullable

x-chat-idstring nullable

organization_idstring required

agent_idstring required

scenariostring nullable

max_turnsinteger

campaign_idstring nullable

targeting_rulesobject[] nullable

contact_idstring nullable

modelstring nullable

variablesobject nullable

include_engagement_historyboolean

per_turn_timeout_secondsnumber

poll_interval_secondsnumber

lead_intakestring nullable

lead_sourcestring

synthetic_leadboolean

lead_namestring nullable

interactiveboolean

variant_idstring nullable

openerstring nullable

Successful Response

engagement_idstring required

statusstring required

turns_totalinteger required

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