Skip to content

by Startups.Studio

Core grammar Limit

Limit.create

POST /{namespace}/limits

Creates a Limit.

Noun: Limit
Mode: do
Event: Limit.created

You, to your agent

Add a limit to LedgerLark.

curl -X POST https://api.sb/ledgerlark.com/limits \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"amount":{"amount":400,"currency":"USD"}}'

import { $ } from 'startup-builder'

const limit = await $.Limit.create({ amount: { amount: 400, currency: 'USD' } })

npx startup-builder do Limit.create --json '{"amount":{"amount":400,"currency":"USD"}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Limit.create({ amount: { amount: 400, currency: 'USD' } })"
  }
}

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

Inputs

Input	Type	Required	Description
`amount`	`money`		The most money it allows.
`count`	`integer`		The most calls or units it allows.
`period`	`string`		The window a rate resets over, such as a month.
`percent`	`number`		The largest share off a reference amount it allows, such as 15 percent off list Price.
`resets`	`string`		One of `calendar`, `rolling`: a calendar Limit resets at the start of each period, a rolling one counts the last period from now.

Outputs

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

Effects

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

Limit

Previous Page

Limit.delete

Next Page