Run a saved model
run_saved_modelRead-only
Calculates a saved model as it stands, with the same engine as the browser builder: ownership after every event for a cap table, proceeds by holder for a waterfall (at the saved exit, or up to 10 exitValuations you pass), or a fund's lifetime totals plus the fund by year (granularity "quarter" or "none" to change that). For a fund, workbook true adds a 24-hour link to the live Excel workbook; that needs the Venture Capital Model, the same as the browser's Excel export. Free: uses no calculations. Needs a signed-in connection.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The model id from list_saved_models. | |
| kind | Yes | "cap-table" (Cap Table builder), "waterfall" (Exit Waterfall builder) or "fund" (the web Venture Capital Model). | |
| workbook | No | Fund only: add a link to the live Excel workbook. | |
| granularity | No | Fund only. | |
| exitValuations | No | Waterfall only: sale prices to run, up to 10. |