POST /scenario/get
Get Scenario
Get scenario information using the canonical shared scenario operation.
Request Body (GetScenarioApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | UUID of the scenario to retrieve |
draft_id | string | No | UUID of the draft |
snapshot_key | string | No | Cache snapshot key for consistent reads across related requests |
names | app__infra__persona__types__SectionFilter | No | — |
descriptions | app__infra__persona__types__SectionFilter | No | — |
problem_statements | app__infra__persona__types__SectionFilter | No | — |
flags | app__infra__persona__types__SectionFilter | No | — |
departments | app__infra__persona__types__SectionFilter | No | — |
personas | app__infra__persona__types__SectionFilter | No | — |
documents | app__infra__persona__types__SectionFilter | No | — |
parameters | app__infra__persona__types__SectionFilter | No | — |
parameter_fields | app__infra__persona__types__SectionFilter | No | — |
objectives | app__infra__persona__types__SectionFilter | No | — |
images | app__infra__persona__types__SectionFilter | No | — |
videos | app__infra__persona__types__SectionFilter | No | — |
questions | app__infra__persona__types__SectionFilter | No | — |
options | app__infra__persona__types__SectionFilter | No | — |
Response (GetScenarioApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
actor_name | string | No | Display name of the current actor |
scenario_exists | boolean | No | Whether the scenario exists |
can_edit | boolean | No | Whether the current user can edit |
disabled_reason | string | No | Reason the scenario is disabled |
group_id | string | No | UUID of the owning group |
draft_name | string | No | Immutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches. |
show_ai_generate | boolean | No | Whether AI generation is available |
resolved_parameter_ids | string[] | No | Resolved parameter IDs from saved fields |
names | ScenarioNameResource[] | No | Name resources |
descriptions | ScenarioDescriptionResource[] | No | Description resources |
problem_statements | ScenarioProblemStatement[] | No | Problem statement resources |
flags | ScenarioFlagResource[] | No | Flag configs |
departments | ScenarioDepartment[] | No | Department resources |
personas | ScenarioPersona[] | No | Persona resources |
documents | ScenarioDocument[] | No | Document resources |
parameters | any[] | No | Parameter resources |
parameter_fields | ScenarioField[] | No | Parameter field resources |
objectives | ScenarioObjective[] | No | Objective resources |
images | ScenarioImage[] | No | Image resources |
videos | ScenarioVideo[] | No | Video resources |
questions | ScenarioQuestion[] | No | Question resources |
options | ScenarioOption[] | No | Option resources |
Last updated on