Skip to content

by Startups.Studio

Role.create

POST /{namespace}/roles

Creates a Role.

Noun: Role
Mode: do
Event: Role.created

You, to your agent

Add a role to PetPantry.

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

import { $ } from 'startup-builder'

const role = await $.Role.create({ name: 'PetPantry' })

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

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

Create makes a new Role 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 title of the seat.
`responsibilities`	`text`		The work the seat owns.
`autonomy`	`json`		How much its agent does without asking: a rung, `assist`, `supervised` or `full`, with another rung per decision class where it differs.
`team`	Team		A Team groups the Roles that do one kind of work under one owner.

Outputs

Output	Type	Required	Description
`role`	Role	required	The Role.

Effects

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

Role

Previous Page

Role.delete

Next Page