create_scenario
Save a named scenario template for a model, defining factor values as fixed, percentile, or shock settings for later reuse in stress-testing.
Instructions
Save a named Moment scenario template for later reuse. This does NOT run a simulation — use compute_returns with the factor values instead, or for ad-hoc tests. IMPORTANT: requires model_id — this is an individual per-asset model UUID from list_model_groups → models[].model_id, NOT the model_group_id. Each scenario is tied to one asset's model. Factor spec format: {'VIX': {'type': 'fixed', 'value': 35}}. Supported types: 'fixed' (exact value), 'percentile' (historical percentile), 'shock' (std dev shift).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Scenario name (e.g. 'Recession', 'Tech Bubble') | |
| model_id | Yes | UUID of the model this scenario applies to | |
| description | No | Optional description | |
| factor_values | Yes | Factor specs (e.g. {'VIX': {'type': 'fixed', 'value': 35}}) | |
| model_group_id | No | Model group UUID (optional, for reference) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |