Hemrock Models API

openapi: 3.2.0
info:
  title: Hemrock Com Models API
  version: 0.1.0
  description: 'Operations tagged Models across 2 of this provider''s published API definitions: hemrock-com-openapi.json, hemrock_com_openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hemrock.com/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Models
paths:
  /models:
    get:
      summary: List the models saved to this account; free
      description: The models saved in the browser builders, plus fund models shared with this account, each with its role (owner, editor, viewer) and a link that opens it in the builder. Needs the `models` scope. Saved-model requests never use calculations.
      security:
      - bearerAuth: []
      parameters:
      - in: query
        name: kind
        schema:
          type: string
          enum:
          - cap-table
          - waterfall
          - fund
          - unit-economics
          - saas-forecasting
          - ecommerce-forecasting
      responses:
        '200':
          description: Saved models
        '401':
          description: Authentication required
        '403':
          description: Credential lacks the models scope
      tags:
      - Models
      operationId: getModels
      x-operation-id-source: derived
    post:
      summary: Save a new model to this account; free
      description: 'Body: `kind` plus that kind''s fields. A cap table takes `events` (the cap-table compute events) and `options`; a waterfall takes `model` (the exit-waterfall model) and `options.exitValuation`; a fund takes `inputs` (merged onto the defaults), `features` and `fundName`; unit-economics, saas-forecasting and ecommerce-forecasting take `inputs` (the same inputs as their compute endpoints, merged onto the defaults). Every kind takes `name`.'
      security:
      - bearerAuth: []
      responses:
        '201':
          description: The saved model
        '400':
          description: Invalid model
      tags:
      - Models
      operationId: postModels
      x-operation-id-source: derived
    servers:
    - url: https://api.hemrock.com/v1
      description: Production
  /models/{kind}/{id}:
    get:
      summary: Read a saved model in the shape the compute API takes; free
      security:
      - bearerAuth: []
      parameters:
      - in: path
        name: kind
        required: true
        schema:
          type: string
          enum:
          - cap-table
          - waterfall
          - fund
          - unit-economics
          - saas-forecasting
          - ecommerce-forecasting
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: The saved model
        '404':
          description: Not found for this account
      tags:
      - Models
      operationId: getModelsByKindById
      x-operation-id-source: derived
    patch:
      summary: Change a saved model; the browser builder sees the change; free
      description: Send only what changes. Fund and kit-model `inputs` merge onto the saved inputs; a `features` entry set to an object switches that feature on with that config and `false` switches it off, keeping its config. `cashFlows` turns the forecast and statements tabs on or off. Cap-table `events` and waterfall `model` replace the saved ones. Owners change anything; invited editors change a fund's inputs while the owner has access; viewers change nothing.
      security:
      - bearerAuth: []
      responses:
        '200':
          description: The updated model
        '400':
          description: Invalid change
        '403':
          description: Not permitted for this role
      tags:
      - Models
      operationId: patchModelsByKindById
      x-operation-id-source: derived
    servers:
    - url: https://api.hemrock.com/v1
      description: Production
  /models/{kind}/{id}/run:
    post:
      summary: Calculate a saved model as it stands; free, uses no calculations
      description: 'Optional body: `exitValuations` (waterfall, up to 10 sale prices; defaults to the saved exit), `granularity` (fund: year, quarter or none) and `workbook` (fund: add a 24-hour link to the live Excel workbook; needs the Venture Capital Model, like the browser export). A kit model returns its `inputs` and `outputs`, the same as its compute endpoint.'
      security:
      - bearerAuth: []
      responses:
        '200':
          description: The calculated model
        '403':
          description: Workbook not included with this account
        '422':
          description: The saved model could not be calculated
      tags:
      - Models
      operationId: postModelsByKindByIdRun
      x-operation-id-source: derived
    servers:
    - url: https://api.hemrock.com/v1
      description: Production
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key (`hk_live_…`), created in the Hemrock developer dashboard. Calls use that account’s product access: lifetime free credits or an active paid allowance.'
x-refined-from:
- hemrock-com-openapi.json


# --- truncated at 32 KB (59 KB total) ---
# Full source: https://artifacts.apis.io/hemrock-com/openapi/hemrock-com-models-api-openapi.yml