Save a new model
create_saved_modelSaves a new model to the user's account so they can open it in the browser builder and keep working on it. A fund starts from Hemrock's defaults with your inputs merged on; a cap table needs events; a waterfall needs a model and options.exitValuation. Use it when the user wants to keep a model you built in chat, and give them the url. Free: uses no calculations. Needs a signed-in connection.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | "cap-table" (Cap Table builder), "waterfall" (Exit Waterfall builder) or "fund" (the web Venture Capital Model). | |
| name | No | The model name shown in the builder. Owner only. | |
| model | No | Waterfall only: the cap stack, the same shape as exit_waterfall_compute's model. Replaces the saved one. | |
| events | No | Cap table only: the full list of financing events, in order, the same shape cap_table_compute takes. Replaces the saved list, so read the model first and send back the whole list with your change. | |
| inputs | No | Fund only: fund inputs to change, the same fields as fund_economics_compute inputs. Merged onto the saved inputs, so send only what changes. | |
| options | No | Cap table: { wholeShares, pricePrecision }. Waterfall: { exitValuation, exitDate, wholeShares, pricePrecision }. Merged onto the saved options. | |
| features | No | Fund only: features to switch on or off, keyed capTable, fees, waterfall, recycling, lpClasses, mgmtCo or followOn, with the same shapes as fund_economics_compute features. An object switches the feature on with that config; false switches it off and keeps its config. The user switches these on deliberately, so only change one they asked about. | |
| fundName | No | Fund only: the fund name used in the model and its workbook. | |
| cashFlows | No | Fund only: show the Forecast and Statements tabs in the builder. |