Bots
Companies
A company is a campus of buildings whose offices are workflows. Items walk each building's pipeline, and gates stop them where a person decides.
A company is a campus. You write it as YAML documents of two kinds and save them like any workflow. A kind: campus document names the buildings, and a kind: building document (or a building written inline in the campus) names its floors of offices, the standard its policy follows, how items come in, and the pipeline an item walks. An office is an ordinary workflow: the agents doing the work.
| Part | What it is |
|---|---|
| Campus | the company: a slug, a mode and its buildings in map order |
| Building | offices on floors, a policy (code or action standard), intake and a pipeline. location: cloud runs on the platform, and location: local runs on your own machine |
| Office | a saved workflow, or one written inline that apply saves as <campus>/<building>/<office> |
| Item | one piece of work put into a building; it walks the pipeline step by step |
| Gate | a pipeline step where the mode and the policy decide: pass, or ask a person (an approval) |
The mode decides who passes a gate. supervised asks a person at every gate. tiered asks according to the standard's tiers. autonomous asks only where the policy says require.
The lifecycle
- Save the documents with
POST /v1/workflowsandkind: campusorkind: building. - Apply: compile them into the stored plan.
- Start the clock: cloud buildings begin walking their items.
- Put items in and watch the snapshot or the event feed.
- Decide the approvals waiting at the door: approve or reject.
- Stop the clock, then delete the company. Delete removes every company row. Your saved documents stay until you delete them.
Every route is in the API reference under Companies. The One API guide's Companies chapter (api.plungeai.com/docs, chapter 17) walks the whole lifecycle with live responses. The errors are 404 company_not_found for a campus that is not yours, 409 conflict for deleting a running company, and 422 invalid_params for a body that breaks a rule.