Skip to content

by Startups.Studio

Core grammar Guard

Guard.update

PATCH /{namespace}/guards/{id}

Changes the given properties of a Guard.

Noun: Guard
Mode: do
Event: Guard.updated

You, to your agent

Change the latest guard.

curl -X PATCH https://api.sb/kilnbakery.com/guards/guard_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tier":"code"}'

import { $ } from 'startup-builder'

const guard = await $.Guard.update({ id: 'guard_1', tier: 'code' })

npx startup-builder do Guard.update --json '{"id":"guard_1","tier":"code"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Guard.update({ id: 'guard_1', tier: 'code' })"
  }
}

Update changes the given properties of a Guard. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Guard.
`tier`	`string`		One of `code`, `model`, `reviewer`, or `human`.
`checks`	`string`		What it refuses; a `claim` Guard checks a stated term or promise against the record that backs it. Never randomized.

Outputs

Output	Type	Required	Description
`guard`	Guard	required	The Guard.

Effects

Emits Guard.updated.
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.	Guard.update

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

Guard.list

Previous Page

Interface

Next Page