Reference
Reference documentation
The reference documentation is part of the software. It ships inside the SDK tarball and the appliance image, and licensed customers can read it in the account portal. The public pages here cover what you need before you have the software.
What the reference covers
| Document | What it covers |
|---|---|
| Authoring agents | Every file in an agent folder, every step kind, the rule condition language, sensitivity and learnable flags. |
| SDK reference | Every export, its signature and behaviour, what it returns and what it refuses. |
| CLI reference | Every engine command with its purpose, an example, and its exit codes. |
| Connectors | Gmail, IMAP, chat channels, connector YAML, and the transport guards on every outbound call. |
| Environment variables | Every variable, where it is read, its default, and whether hosted mode requires it. |
| Appliance deployment | The image, the volume, backup and restore, upgrade with the drift check. |
| Operations | What each console control writes, dead letters, and troubleshooting. |
| Security model | The invariants, the test that pins each one, secrets handling, and what is on the launch plan. |
| Observe and crystallize | Proxy configuration, what is recorded, and how the report is computed. |
Where to find it
- In the SDK tarball, under
docs/, next to the package README. - In the appliance image, served by the console under Help.
- In the account portal, for every licensed tier.
Before you have the software
Start with Concepts for the vocabulary, the Quickstart for the loop from submit to explain, and How authority is earned for the mechanism behind learned rules. The security page answers the questionnaire questions, and the technical review under NDA goes further than the reference does.
Design partners receive the reference documentation with the tarball and image at kickoff. Anyone evaluating the program can ask for it: contact.