Skip to content

by Startups.Studio

Core grammar Noun

Noun.create

POST /{namespace}/nouns

Creates a Noun.

Noun: Noun
Mode: do
Event: Noun.created

You, to your agent

Add a noun to PetPantry.

curl -X POST https://api.sb/petpantry.shop/nouns \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"PetPantry"}'

import { $ } from 'startup-builder'

const noun = await $.Noun.create({ name: 'PetPantry' })

npx startup-builder do Noun.create --json '{"name":"PetPantry"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Noun.create({ name: 'PetPantry' })"
  }
}

Create makes a new Noun 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 singular, capitalized name.
`properties`	`json`		Its properties, each with a name, a type, and whether it is required.
`publishedIn`	Version		The first published Version that serves it; from then on, edits go through a Change and `delete` refuses.
`capability`	Capability		A Capability exposes Verbs on one Noun family, metered, limited and logged under one key.

Outputs

Output	Type	Required	Description
`noun`	Noun	required	The Noun.

Effects

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

Noun

Previous Page

Noun.delete

Next Page