Skip to content

by Startups.Studio

Core grammar Setting

Setting.create

POST /{namespace}/settings

Creates a Setting.

Noun: Setting
Mode: do
Event: Setting.created

You, to your agent

Add a setting to QuietCopy.

curl -X POST https://api.sb/quietcopy.com/settings \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"Example key","value":{}}'

import { $ } from 'startup-builder'

const setting = await $.Setting.create({ key: 'Example key', value: {} })

npx startup-builder do Setting.create --json '{"key":"Example key","value":{}}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Setting.create({ key: 'Example key', value: {} })"
  }
}

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

Inputs

Input	Type	Required	Description
`key`	`string`	required	The name of the choice.
`value`	`json`	required	The chosen value.
`locked`	`boolean`		True when no holder below may override it.
`thing`	Thing		The Thing whose choice a Setting holds; everything below it inherits the value unless it sets its own.

Outputs

Output	Type	Required	Description
`setting`	Setting	required	The Setting.

Effects

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

Setting

Previous Page

Setting.delete

Next Page