Skip to content

by Startups.Studio

Finance Forecast

Forecast.create

POST /{namespace}/forecasts

Creates a Forecast.

Noun: Forecast
Mode: do
Event: Forecast.created

You, to your agent

Add a forecast to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/forecasts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"asOf":"2026-10-22T12:00:00Z","runwayWeeks":1,"defaultAlive":true,"spendState":"free"}'

import { $ } from 'startup-builder'

const forecast = await $.Forecast.create({ asOf: '2026-10-22T12:00:00Z', runwayWeeks: 1, defaultAlive: true, spendState: 'free' })

npx startup-builder do Forecast.create --json '{"asOf":"2026-10-22T12:00:00Z","runwayWeeks":1,"defaultAlive":true,"spendState":"free"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Forecast.create({ asOf: '2026-10-22T12:00:00Z', runwayWeeks: 1, defaultAlive: true, spendState: 'free' })"
  }
}

Create makes a new Forecast from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`asOf`	`datetime`	required	When the inputs were read.
`runwayWeeks`	`number`	required	Weeks until cash reaches zero at the projected rates.
`defaultAlive`	`boolean`	required	True when projected revenue covers projected Cost before cash runs out.
`profitWeek`	`date`		The first week projected revenue covers fully loaded Cost.
`spendState`	`string`	required	The spend state it sets: `free` when default alive, `tight` when default dead, `hold` under 13 weeks of runway.

Outputs

Output	Type	Required	Description
`forecast`	Forecast	required	The Forecast.

Effects

Emits Forecast.created.
Two-way: try, send, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Forecast.create

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Forecast

Previous Page

Forecast.get

Next Page