Skip to content

Worker

A Worker is a Human or an Agent that fills a Role and acts on Tasks.

Properties

PropertyTypeRequiredDescription
namestringrequiredThe name the Worker goes by in a Startup.
instructionstextHow the Worker does its work.

Object

JSON
{
  "$id": "https://api.sb/quietcopy.com/workers/worker_1",
  "$type": "Worker",
  "name": "QuietCopy",
  "instructions": "Example instructions"
}

Relationships

Verbs

  1. createCreates a Worker.
    POST /{namespace}/workersdoWorker.created
  2. getReturns one Worker by id.
    GET /{namespace}/workers/{id}readNo Event
  3. listReturns Workers, newest first, one page at a time.
    GET /{namespace}/workersreadNo Event
  4. updateChanges the given properties of a Worker.
    PATCH /{namespace}/workers/{id}doWorker.updated
  5. deleteDeletes a Worker; its history is kept.
    DELETE /{namespace}/workers/{id}doWorker.deleted

Permissions

Which Access level may call each Verb. One-way Verbs wait their delay window.

Operationowneradminmemberviewer
Worker.createYesYesYesNo
Worker.getYesYesYesYes
Worker.listYesYesYesYes
Worker.updateYesYesYesNo
Worker.deleteYesYesYesNo

Call it

Text
Add a worker to TutorLoop.

Example

At a tax-preparation service, Nora the Payroll Specialist and a credentialed preparer are both Workers. Each fills a Role, works Tasks, and keeps its own Memory.