---
title: "Generate a scenario table from a generator."
method: POST
path: "/api/v1/ScenarioTables/Generate"
tags: ["ScenarioTables"]
---

# Generate a scenario table from a generator.

`POST /api/v1/ScenarioTables/Generate`

## Request

- Base URL: `https://api.slopesoftware.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.slopesoftware.com/api/v1/ScenarioTables/Generate`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/slopesoftware/apis/akur8-life-api/docs/api/v1/ScenarioTables/Generate/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- GenerateScenarioTableRequestV1
  - `modelId` integer, required: Model ID.
  - `generatorType` 'NAICGenerator', nullable: Economic scenario generator type. Valid values: NAICGenerator
  - `name` string, required: Name of the scenario table to be generated.
  - `filePath` string, required: Slope file path where the generated scenario table will be stored.
  - `yearsToProject` integer, required: Number of years to project.
  - `yieldCurveRateType` 'BondEquivalent' | 'SpotRate', nullable: Yield curve rate type for generated scenario tables. Valid values: BondEquivalent, SpotRate
  - `naicGeneratorParameters` NaicGeneratorParametersRequestV1
    - `datasetDate` string, required: Dataset date for the NAIC generator. Expected format: YYYY-MM-DD
    - `scenarioSet` 'Full10000Scenarios' | 'SubsetScenarios' | 'StochasticExclusionTestScenarios', nullable: The NAIC generator scenario set type. Valid values: Full10000Scenarios, SubsetScenarios, StochasticExclusionTestScenarios
    - `numberOfScenarios` integer, nullable: Number of scenarios to generate. Used by the NAIC generator.
    - `scenarioSubsetMethod` 'SignificanceValue' | 'LargeCapGrowthWealthFactor' | 'FirstN', nullable: The NAIC generator scenario subset method. Valid values: SignificanceValue, LargeCapGrowthWealthFactor, FirstN
    - `scenarioNumbering` 'RenumberInAscendingOrder' | 'KeepOriginalScenarioNumbers', nullable: The NAIC generator scenario numbering method. Valid values: RenumberInAscendingOrder, KeepOriginalScenarioNumbers
    - `variableRateMappings` NaicVariableRateMappingRequestV1[], nullable: List of variable rate mappings for the NAIC scenario generator.
      - `variableRateId` integer, required: Variable rate ID.
      - `returnTypeName` string, required: Return type name.
      - `returnComponentName` string, required: Return component name.

## Response `200`

OK

- GenerateScenarioTableResponseV1
  - `generationId` integer: The ID used to check the status of the scenario table generation

## Other responses

- `201`: Created
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Not Allowed To Access
- `404`: Not Found
- `429`: Too Many Requests

---

[API](https://skmtc.dev/slopesoftware/apis/akur8-life-api.md) - [All operations](https://skmtc.dev/slopesoftware/apis/akur8-life-api/llms.txt) - [OpenAPI document](https://skmtc.dev/slopesoftware/apis/akur8-life-api/revisions/9771b2c79880?raw)
