Skip to content

by Startups.Studio

Core grammar Verb

Verb.create

POST /{namespace}/verbs

Creates a Verb.

Noun: Verb
Mode: do
Event: Verb.created

You, to your agent

Add a verb to ShiftNote.

curl -X POST https://api.sb/shiftnote.app/verbs \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"ShiftNote","event":"Example event"}'

import { $ } from 'startup-builder'

const verb = await $.Verb.create({ name: 'ShiftNote', event: 'Example event' })

npx startup-builder do Verb.create --json '{"name":"ShiftNote","event":"Example event"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Verb.create({ name: 'ShiftNote', event: 'Example event' })"
  }
}

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

Inputs

Input	Type	Required	Description
`name`	`string`	required	The camelCase action form.
`event`	`string`	required	The event the Verb emits.
`publishedIn`	Version		The first published Version that serves it; from then on, edits go through a Change and `delete` refuses.
`noun`	Noun		Every Verb acts on one Noun, which names it: `Startup.launch` acts on Startup.
`mode`	Mode		The Mode a call uses when the caller names none: `try`, `send` or `do`.

Outputs

Output	Type	Required	Description
`verb`	Verb	required	The Verb.

Effects

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

Verb

Previous Page

Verb.delete

Next Page