Skip to content

by Startups.Studio

Core grammar Thing Collection

Collection.create

POST /{namespace}/collections

Creates a Collection.

Noun: Collection
Mode: do
Event: Collection.created

You, to your agent

Add a collection to PetPantry with a noun.

curl -X POST https://api.sb/petpantry.shop/collections \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"collection_1","type":["noun_1"]}'

import { $ } from 'startup-builder'

const collection = await $.Collection.create({ id: 'collection_1', type: ['noun_1'] })

npx startup-builder do Collection.create --json '{"id":"collection_1","type":["noun_1"]}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Collection.create({ id: 'collection_1', type: ['noun_1'] })"
  }
}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The stable identifier, which never changes.
`type`	list of Noun	required	The Nouns this Thing is an instance of.
`outside`	`json`		The ids this Thing has in outside tools, one per Integration, so a re-run matches instead of duplicating.
`query`	`json`		The saved query that defines a dynamic Collection.

Outputs

Output	Type	Required	Description
`collection`	Collection	required	The Collection.

Effects

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

Collection

Previous Page

Collection.delete

Next Page