Skip to content

by Startups.Studio

Core grammar Limit

Limit.raise

POST /{namespace}/limits/{limit}/raise

Raise lifts a Limit after an Approval allows it, and the Action that waited on it proceeds.

Noun: Limit
Mode: do
Event: Limit.raised

You, to your agent

Raise the latest limit.

curl -X POST https://api.sb/ledgerlark.com/limits/limit_1/raise \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":{}}'

import { $ } from 'startup-builder'

const limit = await $.Limit.raise({ limit: 'limit_1', to: {} })

npx startup-builder do Limit.raise --json '{"limit":"limit_1","to":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Limit.raise({ limit: 'limit_1', to: {} })"
  }
}

Inputs

Input	Type	Required	Description
`limit`	Limit	required	The Limit to lift.
`to`	`json`	required	The new amount, count or rate.

Outputs

Output	Type	Required	Description
`limit`	Limit	required	The raised Limit.

Effects

Emits Limit.raised.
Performed by the Founder.
One-way (money): it waits out its delay window, and runs in the send and do modes.

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.	Limit.raise
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Limit.raise

When it waits

Gate	Default
Decision class	Medium: one-way, bounded (money)
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The spend Limit of the Permission or Mandate 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`.

Limit.list

Previous Page

Limit.update

Next Page