Skip to content

by Startups.Studio

OverviewPortfolio

Portfolio.brake

POST /{namespace}/portfolios/{portfolio}/brake

Brake stops one class of effects, such as sends, spend, publishes, or price changes, across a Portfolio query until it expires or is lifted.

Noun: Portfolio
Mode: do
Event: Portfolio.braked

You, to your agent

Brake the latest portfolio.

curl -X POST https://api.sb/ledgerlark.com/portfolios/portfolio_1/brake \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"effects":["send"],"reason":"Example reason","until":"2026-10-22T12:00:00Z"}'

import { $ } from 'startup-builder'

const { brake, portfolio } = await $.Portfolio.brake({ portfolio: 'portfolio_1', effects: ['send'], reason: 'Example reason', until: '2026-10-22T12:00:00Z' })

npx startup-builder do Portfolio.brake --json '{"portfolio":"portfolio_1","effects":["send"],"reason":"Example reason","until":"2026-10-22T12:00:00Z"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Portfolio.brake({ portfolio: 'portfolio_1', effects: ['send'], reason: 'Example reason', until: '2026-10-22T12:00:00Z' })"
  }
}

Inputs

Input	Type	Required	Description
`portfolio`	Portfolio	required	The Portfolio whose Startups the brake covers.
`effects`	`string[]`	required	Any of `send`, `spend`, `publish`, and `price`.
`reason`	`text`	required	Why the effects stop.
`until`	`datetime`	required	When the brake expires.
`query`	`string`		Narrows the brake to the Startups that match, such as one Startup Template Version or one Cohort.

Outputs

Output	Type	Required	Description
`brake`	Setting	required	The brake, held as a Setting that every matching Startup inherits.
`portfolio`	Portfolio	required	The Portfolio under the brake.

Effects

Emits Portfolio.braked.
Holds every new Action of a braked effect as pending until the brake ends; nothing already done is undone.
Records a Decision with the reason.

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.	Portfolio.brake

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`.