Skip to content

by Startups.Studio

Role.staff

POST /{namespace}/roles/{role}/staff

Staff fills a Role with a Worker, human or agent, who then performs the Role’s Verbs under its Permissions.

Noun: Role
Mode: do
Event: Role.staffed

You, to your agent

Staff the latest role with a worker.

curl -X POST https://api.sb/kilnbakery.com/roles/role_1/staff \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"worker":"worker_1"}'

import { $ } from 'startup-builder'

const role = await $.Role.staff({ role: 'role_1', worker: 'worker_1' })

npx startup-builder do Role.staff --json '{"role":"role_1","worker":"worker_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Role.staff({ role: 'role_1', worker: 'worker_1' })"
  }
}

Inputs

Input	Type	Required	Description
`role`	Role	required	The Role to fill.
`worker`	Worker	required	The Worker who fills it.

Outputs

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

Effects

Emits Role.staffed.
Performed by the People Lead.
Gives a new agent Worker its name for this Startup.

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.staff
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Role.staff

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.review

Previous Page

Role.update

Next Page